galah (version 1.5.4)

galah_select: Specify fields for occurrence download

Description

The living atlases store content in hundreds of different fields, and users often require thousands or millions of records at a time. To reduce time taken to download data, and limit complexity of the resulting data.frame, it is sensible to restrict the fields returned by atlas_occurrences(). This function allows easy selection of fields, or commonly-requested groups of columns, following syntax shared with dplyr::select().

Usage

galah_select(..., group = c("basic", "event", "media", "assertions"))

Value

A tibble specifying the name and type of each column to include in the call to atlas_counts() or atlas_occurrences().

Arguments

...

zero or more individual column names to include

group

string: (optional) name of one or more column groups to include. Valid options are "basic", "event" and "assertions"

Details

The full list of available fields can be viewed with show_all(fields).

Calling the argument group = "basic" returns the following columns:

• decimalLatitude

• decimalLongitude

• eventDate

• scientificName

• taxonConceptID

• recordID

• dataResourceName

• occurrenceStatus

Using group = "event" returns the following columns:

• eventRemarks

• eventTime

• eventID

• eventDate

• samplingEffort

• samplingProtocol

Using group = "media" returns the following columns:

• multimedia

• multimediaLicence

• images

• videos

• sounds

Using group = "assertions" returns all quality assertion-related columns. The list of assertions is shown by show_all_assertions().

See Also

search_taxa(), galah_filter() and galah_geolocate() for other ways to restrict the information returned by atlas_occurrences() and related functions; atlas_counts() for how to get counts by levels of variables returned by galah_select; show_all(fields) to list available fields.

Examples

if (FALSE) {
# Download occurrence records of *Perameles*, 
# Only return scientificName and eventDate columns
galah_config(email = "[e-mail]")
galah_call() |>
  galah_identify("perameles")|>
  galah_select(scientificName, eventDate) |>
  atlas_occurrences()

# Only return the "basic" group of columns and the basisOfRecord column
galah_call() |>
  galah_identify("perameles") |>
  galah_select(basisOfRecord, group = "basic") |>
  atlas_occurrences()
}