Filter to just data collected following a specific search protocol: stationary, traveling, or casual. 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_protocol(x, protocol)

Arguments

x

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

protocol

character. Many protocols exist in the database, however, the most commonly used are:

  • Stationary

  • Traveling

  • Area

  • Incidental

A complete list of valid protocols is contained within the vector valid_protocols within this package. Multiple protocols are allowed at the same time.

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

system.file("extdata/ebd-sample.txt", package = "auk") %>% auk_ebd() %>% auk_protocol("Stationary")
#> Input #> EBD: /cache/auk/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: all #> States: all #> BCRs: all #> Bounding box: full extent #> Date: all #> Start time: all #> Last edited date: all #> Protocol: Stationary #> 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_protocol(ebd, "Stationary")
#> Input #> EBD: /cache/auk/extdata/ebd-sample.txt #> #> Output #> Filters not executed #> #> Filters #> Species: all #> Countries: all #> States: all #> BCRs: all #> Bounding box: full extent #> Date: all #> Start time: all #> Last edited date: all #> Protocol: Stationary #> Project code: all #> Duration: all #> Distance travelled: all #> Records with breeding codes only: no #> Complete checklists only: no