auk (version 0.2.2)

auk_species: Filter the eBird data by species

Description

Define a filter for the eBird Basic Dataset (EBD) based on species. This function only defines the filter and, once all filters have been defined, auk_filter() should be used to call AWK and perform the filtering.

Usage

auk_species(x, species, replace)

Arguments

x

auk_ebd object; reference to object created by auk_ebd().

species

character; species to filter by, provided as scientific or English common names, or a mixture of both. These names must match the official eBird Taxomony (ebird_taxonomy).

replace

logical; multiple calls to auk_species() are additive, unless replace = FALSE, in which case the previous list of species to filter by will be removed and replaced by that in the current call.

Value

An auk_ebd object.

See Also

Other filter: auk_breeding, auk_complete, auk_country, auk_date, auk_distance, auk_duration, auk_extent, auk_filter, auk_last_edited, auk_project, auk_protocol, auk_state, auk_time

Examples

# NOT RUN {
# common and scientific names can be mixed
species <- c("Gray Jay", "Pluvialis squatarola")
system.file("extdata/ebd-sample.txt", package = "auk") %>%
  auk_ebd() %>%
  auk_species(species)
  
# alternatively, without pipes
ebd <- auk_ebd(system.file("extdata/ebd-sample.txt", package = "auk"))
auk_species(ebd, species)
# }