atlas_media: Download images, sounds and videos

Description

In addition to text data describing individual occurrences and their attributes, ALA stores images, sounds and videos associated with a given record. atlas_media allows download of any and all of the media types.

Usage

atlas_media(
  request = NULL,
  identify = NULL,
  filter = NULL,
  geolocate = NULL,
  select = galah_select(group = "basic"),
  download_dir,
  refresh_cache = FALSE
)

Arguments

request

optional data_rquest object: generated by a call to galah_call().

identify

data.frame: generated by a call to galah_identify().

filter

data.frame: generated by a call to galah_filter()

geolocate

string: generated by a call to galah_geolocate()

select

data.frame: generated by a call to galah_select()

download_dir

string: path to directory to store the downloaded media in

refresh_cache

logical: if set to TRUE and galah_config(caching = TRUE) then files cached from a previous query will be replaced by the current query

Value

An object of class tbl_df and data.frame (aka a tibble) of metadata of the downloaded media

Examples

Download Regent Honeyeater multimedia

media_data <- galah_call() |>
    galah_identify("Regent Honeyeater") |>
    galah_filter(year == 2011) |>
    atlas_media(download_dir = "folder/your-directory")

Specify a single media type to download

media_data <- galah_call(
     galah_identify("Eolophus Roseicapilla") |>
     galah_filter(multimedia == "Sound") |>
     atlas_media()

Filter to only records with a particular licence type (DOESN'T WORK)

media_data <- galah_call()
      galah_identify("Ornithorhynchus anatinus") |>
      galah_filter(year == 2020,
        license = "http://creativecommons.org/licenses/by-nc/4.0/") |>
       atlas_media()
)

You might also want to check how many records have media files before you download them. Do this with atlas_counts()

galah_call() |>
     galah_filter(multimedia == c("Image","Sound","Video")) |>
     galah_group_by(multimedia) |>
     atlas_counts()

Details