Define a filter for the eBird Basic Dataset (EBD) based on a range of dates.
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.
Arguments
- x
auk_ebdorauk_samplingobject; reference to file created byauk_ebd()orauk_sampling().- date
character or date; date range to filter by, provided either as a character vector in the format
"2015-12-31"or a vector of Date objects. To filter on a range of dates, regardless of year, use"*"in place of the year.
Details
To select observations from a range of dates, regardless of year,
the wildcard "*" can be used in place of the year. For example, using
date = c("*-05-01", "*-06-30") will return observations from May and June
of any year. When using wildcards, dates can wrap around the year end.
This function can also work with on an auk_sampling object if the user only
wishes to filter the sampling event data.
See also
Other filter:
auk_bbox(),
auk_bcr(),
auk_breeding(),
auk_complete(),
auk_country(),
auk_county(),
auk_distance(),
auk_duration(),
auk_exotic(),
auk_extent(),
auk_filter(),
auk_last_edited(),
auk_observer(),
auk_project(),
auk_protocol(),
auk_species(),
auk_state(),
auk_time(),
auk_year()
Examples
system.file("extdata/ebd-sample.txt", package = "auk") %>%
auk_ebd() %>%
auk_date(date = c("2010-01-01", "2010-12-31"))
#> Input
#> EBD: /usr/local/lib/R/site-library/auk/extdata/ebd-sample.txt
#>
#> Output
#> Filters not executed
#>
#> Filters
#> Species: all
#> Countries: all
#> States: all
#> Counties: all
#> BCRs: all
#> Bounding box: full extent
#> Years: all
#> Date: 2010-01-01 - 2010-12-31
#> Start time: all
#> Last edited date: all
#> Protocol: all
#> Project code: all
#> Duration: all
#> Distance travelled: all
#> Records with breeding codes only: no
#> Exotic Codes: all
#> Complete checklists only: no
# alternatively, without pipes
ebd <- auk_ebd(system.file("extdata/ebd-sample.txt", package = "auk"))
auk_date(ebd, date = c("2010-01-01", "2010-12-31"))
#> Input
#> EBD: /usr/local/lib/R/site-library/auk/extdata/ebd-sample.txt
#>
#> Output
#> Filters not executed
#>
#> Filters
#> Species: all
#> Countries: all
#> States: all
#> Counties: all
#> BCRs: all
#> Bounding box: full extent
#> Years: all
#> Date: 2010-01-01 - 2010-12-31
#> Start time: all
#> Last edited date: all
#> Protocol: all
#> Project code: all
#> Duration: all
#> Distance travelled: all
#> Records with breeding codes only: no
#> Exotic Codes: all
#> Complete checklists only: no
# the * wildcard can be used in place of year to select dates from all years
system.file("extdata/ebd-sample.txt", package = "auk") %>%
auk_ebd() %>%
# may-june records from all years
auk_date(date = c("*-05-01", "*-06-30"))
#> Input
#> EBD: /usr/local/lib/R/site-library/auk/extdata/ebd-sample.txt
#>
#> Output
#> Filters not executed
#>
#> Filters
#> Species: all
#> Countries: all
#> States: all
#> Counties: all
#> BCRs: all
#> Bounding box: full extent
#> Years: all
#> Date: *-05-01 - *-06-30
#> Start time: all
#> Last edited date: all
#> Protocol: all
#> Project code: all
#> Duration: all
#> Distance travelled: all
#> Records with breeding codes only: no
#> Exotic Codes: all
#> Complete checklists only: no
# dates can also wrap around the end of the year
system.file("extdata/ebd-sample.txt", package = "auk") %>%
auk_ebd() %>%
# dec-jan records from all years
auk_date(date = c("*-12-01", "*-01-31"))
#> Input
#> EBD: /usr/local/lib/R/site-library/auk/extdata/ebd-sample.txt
#>
#> Output
#> Filters not executed
#>
#> Filters
#> Species: all
#> Countries: all
#> States: all
#> Counties: all
#> BCRs: all
#> Bounding box: full extent
#> Years: all
#> Date: *-12-01 - *-01-31
#> Start time: all
#> Last edited date: all
#> Protocol: all
#> Project code: all
#> Duration: all
#> Distance travelled: all
#> Records with breeding codes only: no
#> Exotic Codes: all
#> Complete checklists only: no