Get taxa — get_taxa • ratlas

The function downloads and returns a list or dataframe containing a taxonomic description for each requested species where a row corresponds to an individual species. The function returns a dataframe for all species if no parameters are specified. The function filters returned taxa record by attributes corresponding to atlas table columns specified as parameters (ie. id, scientific_name, col, gbif, etc) with accepted values either being scalar or vector for single or multiple records

Usage

get_taxa(id = NULL, scientific_name = NULL, match_name = NULL, ...)

Arguments

id: Optional. integer scalar or vector. Returns a dataframe for the taxon with the specified id
scientific_name: Optional. char scalar or vector. Returns a dataframe for the taxon with the specified scientific name
match_name: Optional. char scalar or vector. Returns a dataframe for the taxon with the specified scientific name or vernacular name. Vernacular names in french or english are accepted.
...: Optional. scalar or vector. Returns a dataframe filtered by the atlas taxa table columns specified as parameter

Value

tibble with rows associated with Atlas data object

Examples

# Returns all available taxa records in atlas
taxa <- get_taxa()

# Returns all taxa filtered by the column id values
taxa <- get_taxa(id = c(188, 201, 294, 392))

# Returns taxa record for the scientific name
taxa <- get_taxa(scientific_name = "Cyanocitta cristata")

# Return taxa filtered by the atlas table column `col`
results <- get_taxa(col = 35520954)