auk_protocol: Filter the eBird data by protocol

In auk: eBird Data Extraction and Processing in R

Filter the eBird data by protocol

Description

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.

Usage

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.

Details

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

Value

An auk_ebd object.

See Also

Other filter: auk_bbox(), auk_bcr(), auk_breeding(), auk_complete(), auk_country(), auk_county(), auk_date(), auk_distance(), auk_duration(), auk_exotic(), auk_extent(), auk_filter(), auk_last_edited(), auk_observer(), auk_project(), auk_species(), auk_state(), auk_time(), auk_year()

Examples

system.file("extdata/ebd-sample.txt", package = "auk") %>%
  auk_ebd() %>%
  auk_protocol("Stationary")
  
# alternatively, without pipes
ebd <- auk_ebd(system.file("extdata/ebd-sample.txt", package = "auk"))
auk_protocol(ebd, "Stationary")

auk documentation built on June 8, 2025, 12:44 p.m.