auk_country: Filter the EBD by country

Description Usage Arguments Value Examples

Description

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.

Usage

1
auk_country(x, country, replace)

Arguments

x

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

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.

Examples

1
2
3
4
5
6
# 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)

mstrimas/auk documentation built on May 20, 2019, 5:26 p.m.