Package: auk 0.9.2

Matthew Strimas-Mackey

auk: eBird Data Extraction and Processing in R

Extract and process bird sightings records from eBird (<http://ebird.org>), an online tool for recording bird observations. Public access to the full eBird database is via the eBird Basic Dataset (EBD; see <http://ebird.org/ebird/data/download> for access), a downloadable text file. This package is an interface to AWK for extracting data from the EBD based on taxonomic, spatial, or temporal filters, to produce a manageable file size that can be imported into R.

Authors:Matthew Strimas-Mackey [aut, cre], Eliot Miller [aut], Wesley Hochachka [aut], Cornell Lab of Ornithology [cph]

auk_0.9.2.tar.gz
auk_0.9.2.zip(r-4.7)auk_0.9.2.zip(r-4.6)auk_0.9.2.zip(r-4.5)
auk_0.9.2.tgz(r-4.6-any)auk_0.9.2.tgz(r-4.5-any)
auk_0.9.2.tar.gz(r-4.7-any)auk_0.9.2.tar.gz(r-4.6-any)
auk_0.9.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
auk/json (API)

# Install 'auk' in R:
install.packages('auk', repos = c('https://packages.ropensci.org', 'https://cloud.r-project.org'))

Reviews:rOpenSci Software Review #136

Bug tracker:https://github.com/cornelllabofornithology/auk/issues

Pkgdown/docs site:https://cornelllabofornithology.github.io

Datasets:

On CRAN:

Conda:

datasetebird

9.80 score 161 stars 1 packages 398 scripts 1.0k downloads 1 mentions 42 exports 38 dependencies

Last updated from:e2fc3cda77 (on main). Checks:10 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK151
pkgdown docsOK169
source / vignettesOK266
linux-release-x86_64OK162
macos-release-arm64OK102
macos-oldrel-arm64OK101
windows-develOK96
windows-releaseOK128
windows-oldrelOK108
wasm-releaseOK159

Exports:auk_bboxauk_bcrauk_breedingauk_cleanauk_completeauk_countryauk_countyauk_dateauk_distanceauk_durationauk_ebdauk_ebd_versionauk_exoticauk_extentauk_filterauk_get_awk_pathauk_get_ebd_pathauk_last_editedauk_observerauk_projectauk_protocolauk_rollupauk_samplingauk_selectauk_set_awk_pathauk_set_ebd_pathauk_speciesauk_splitauk_stateauk_timeauk_uniqueauk_versionauk_yearauk_zerofillcollapse_zerofillebird_speciesfilter_repeat_visitsformat_unmarked_occuget_ebird_taxonomyprocess_barchartsread_ebdread_sampling

Dependencies:askpassassertthatbitbit64clicliprcountrycodecpp11crayoncurldplyrgenericsgluehmshttr2lifecyclemagrittropensslpillarpkgconfigprettyunitsprogresspurrrR6rappdirsreadrrlangstringistringrsystibbletidyrtidyselecttzdbutf8vctrsvroomwithr

Introduction to auk
Quick start | Background | The eBird Basic Dataset | auk vs. rebird | Data access | Example data | AWK | A note on versions | Presence data | The auk_ebd object | Defining filters | Executing filters | Reading | Saving the AWK command | Group checklists | Taxonomic rollup | Zero-filled, presence-absence data | Filtering | Reading and zero-filling | Acknowledgements | References

Last update: 2026-01-12
Started: 2017-07-01

auk development
Updating the eBird taxonomy | Adding new filters | 1. Update auk_ebd() | 2. Create filter function | 3. Update auk_filter() | 4. Unit tests | 5. Update vignette and README | 6. Build, test, check, and push to GitHub | CRAN submission

Last update: 2025-12-17
Started: 2017-10-12

Readme and manuals

Help Manual

Help pageTopics
Filter the eBird data by spatial bounding boxauk_bbox
Filter the eBird data by Bird Conservation Regionauk_bcr
Filter to only include observations with breeding codesauk_breeding
Clean an eBird data file (Deprecated)auk_clean
Filter out incomplete checklists from the eBird dataauk_complete
Filter the eBird data by countryauk_country
Filter the eBird data by countyauk_county
Filter the eBird data by dateauk_date
Filter eBird data by distance travelledauk_distance
Filter the eBird data by durationauk_duration
Reference to eBird data fileauk_ebd
Get the EBD version and associated taxonomy versionauk_ebd_version
Filter the eBird data by exotic codeauk_exotic
Filter the eBird data by spatial extentauk_extent
Filter the eBird file using AWKauk_filter auk_filter.auk_ebd auk_filter.auk_sampling
OS specific path to AWK executableauk_get_awk_path
Return EBD data pathauk_get_ebd_path
Filter the eBird data by last edited dateauk_last_edited
Filter the eBird data by observerauk_observer
Filter the eBird data by project codeauk_project
Filter the eBird data by protocolauk_protocol
Roll up eBird taxonomy to speciesauk_rollup
Reference to eBird sampling event fileauk_sampling
Select a subset of columnsauk_select
Set a custom path to AWK executableauk_set_awk_path
Set the path to EBD text filesauk_set_ebd_path
Filter the eBird data by speciesauk_species
Split an eBird data file by speciesauk_split
Filter the eBird data by stateauk_state
Filter the eBird data by checklist start timeauk_time
Remove duplicate group checklistsauk_unique
Versions of auk, the EBD, and the eBird taxonomyauk_version
Filter the eBird data to a set of yearsauk_year
Read and zero-fill an eBird data fileauk_zerofill auk_zerofill.auk_ebd auk_zerofill.character auk_zerofill.data.frame collapse_zerofill
BCR Codesbcr_codes
Lookup species in eBird taxonomyebird_species
eBird Statesebird_states
eBird Taxonomyebird_taxonomy
Filter observations to repeat visits for hierarchical modelingfilter_repeat_visits
Format EBD data for occupancy modeling with 'unmarked'format_unmarked_occu
Get eBird taxonomy via the eBird APIget_ebird_taxonomy
Process eBird bar chart dataprocess_barcharts
Read an EBD fileread_ebd read_ebd.auk_ebd read_ebd.character read_sampling read_sampling.auk_ebd read_sampling.auk_sampling read_sampling.character
Valid Protocolsvalid_protocols