Define a filter for the eBird Basic Dataset (EBD) based on a set of countries. 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.

auk_country(x, country, replace = FALSE)

Arguments

x

auk_ebd or auk_sampling object; reference to file created by auk_ebd() or auk_sampling().

country

character; countries to filter by. Countries can either be expressed as English names or ISO 2-letter country codes. English names are matched via regular expressions using countrycode, so there is some flexibility in names.

replace

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

Value

An auk_ebd object.

Details

This function can also work with on an auk_sampling object if the user only wishes to filter the sampling event data.

See also

Examples

# country names and ISO2 codes can be mixed # not case sensitive country <- c("CA", "United States", "mexico") system.file("extdata/ebd-sample.txt", package = "auk") %>% auk_ebd() %>% auk_country(country)
#> Input #> EBD: /Users/mes335/projects/auk/inst/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: CA, MX, US #> States: all #> BCRs: all #> Bounding box: full extent #> Date: all #> Start time: all #> Last edited date: all #> Protocol: all #> Project code: all #> Duration: all #> Distance travelled: all #> Records with breeding codes only: no #> Complete checklists only: no
# alternatively, without pipes ebd <- auk_ebd(system.file("extdata/ebd-sample.txt", package = "auk")) auk_country(ebd, country)
#> Input #> EBD: /Users/mes335/projects/auk/inst/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: CA, MX, US #> States: all #> BCRs: all #> Bounding box: full extent #> Date: all #> Start time: all #> Last edited date: all #> Protocol: all #> Project code: all #> Duration: all #> Distance travelled: all #> Records with breeding codes only: no #> Complete checklists only: no