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.

auk_date(x, date)

Arguments

x

auk_ebd or auk_sampling object; reference to file created by auk_ebd() or auk_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.

Value

An auk_ebd object.

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

Examples

system.file("extdata/ebd-sample.txt", package = "auk") %>% auk_ebd() %>% auk_date(date = c("2010-01-01", "2010-12-31"))
#> Input #> EBD: /Users/mes335/projects/auk/inst/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: all #> States: all #> BCRs: all #> Bounding box: full extent #> 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 #> 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: /Users/mes335/projects/auk/inst/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: all #> States: all #> BCRs: all #> Bounding box: full extent #> 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 #> 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: /Users/mes335/projects/auk/inst/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: all #> States: all #> BCRs: all #> Bounding box: full extent #> 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 #> 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("*-01-01", "*-01-31"))
#> Input #> EBD: /Users/mes335/projects/auk/inst/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: all #> States: all #> BCRs: all #> Bounding box: full extent #> Date: *-01-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 #> Complete checklists only: no