{"id":15554891,"url":"https://github.com/ropensci/rebird","last_synced_at":"2025-05-16T07:04:05.822Z","repository":{"id":2432052,"uuid":"3401528","full_name":"ropensci/rebird","owner":"ropensci","description":"Wrapper to the eBird API","archived":false,"fork":false,"pushed_at":"2025-05-01T17:35:11.000Z","size":4007,"stargazers_count":90,"open_issues_count":2,"forks_count":17,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-05-01T18:38:03.312Z","etag":null,"topics":["birds","ebird","ebird-api","ebird-webservices","r","r-package","rstats","spocc"],"latest_commit_sha":null,"homepage":"https://docs.ropensci.org/rebird","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ropensci.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json","zenodo":null}},"created_at":"2012-02-09T21:35:39.000Z","updated_at":"2025-05-01T17:35:15.000Z","dependencies_parsed_at":"2024-01-21T22:52:42.141Z","dependency_job_id":"d57e8e1d-4e62-49d8-8f70-497b565151b1","html_url":"https://github.com/ropensci/rebird","commit_stats":{"total_commits":482,"total_committers":16,"mean_commits":30.125,"dds":0.5995850622406639,"last_synced_commit":"2e74bdfde3e8757186aebb3ef827673fa89e01d2"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Frebird","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Frebird/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Frebird/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ropensci%2Frebird/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ropensci","download_url":"https://codeload.github.com/ropensci/rebird/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254303186,"owners_count":22048183,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["birds","ebird","ebird-api","ebird-webservices","r","r-package","rstats","spocc"],"created_at":"2024-10-02T15:04:07.450Z","updated_at":"2025-05-16T07:04:05.801Z","avatar_url":"https://github.com/ropensci.png","language":"R","funding_links":[],"categories":["Observation and Conservation of Ecosystems"],"sub_categories":["Vegitation and Biodiversity"],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\"\n)\n```\n\n# rebird: wrapper to the eBird API\n\n\u003c!-- badges: start --\u003e\n[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)\n[![R-CMD-check](https://github.com/ropensci/rebird/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/rebird/actions/workflows/R-CMD-check.yaml)\n[![Codecov test coverage](https://codecov.io/gh/ropensci/rebird/graph/badge.svg)](https://app.codecov.io/gh/ropensci/rebird)\n[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rebird)](https://github.com/r-hub/cranlogs.app)\n[![cran version](https://www.r-pkg.org/badges/version/rebird)](https://cran.r-project.org/package=rebird/)\n\u003c!-- badges: end --\u003e\n\n`rebird` is a package to interface with the eBird webservices.\n\neBird is a real-time, online bird checklist program. For more information, visit their website: https://ebird.org/home\n\nThe API for the eBird webservices can be accessed here: https://documenter.getpostman.com/view/664302/S1ENwy59?version=latest\n\n## Install\n\nYou can install the stable version from CRAN\n\n```{r eval=FALSE}\ninstall.packages(\"rebird\")\n```\n\nOr the development version from Github\n\n```{r eval=FALSE}\ninstall.packages(\"devtools\")\ndevtools::install_github(\"ropensci/rebird\")\n```\n\n\n# Direct use of `rebird`\n\nLoad the package:\n\n```{r}\nlibrary(\"rebird\")\n```\n\nThe [eBird API server](https://documenter.getpostman.com/view/664302/S1ENwy59?version=latest)\nrequires users to provide an API key, which is linked to your eBird user account. \nYou can pass it to the 'key' argument in `rebird` functions, but we highly recommend\nstoring it as an environment variable called EBIRD_KEY in your .Renviron file.\nIf you don't have a key, you can obtain one from \u003chttps://ebird.org/api/keygen\u003e.\n\nYou can keep your .Renviron file in your global R home directory (`R.home()`), your user's home\ndirectory (`Sys.getenv(\"HOME\")`), or your current working directory (`getwd()`). Remember\nthat .Renviron is loaded once when you start R, so if you add your API key to the file you will\nhave to restart your R session. See `?Startup` for more information on R's startup files.\n\nFurthermore, functions now use species codes, rather than scientific names, for species-specific requests.\nWe've made the switch easy by providing the `species_code` function, which converts a scientific name to\nits species code:\n\n```{r speciescode}\nspecies_code('sula variegata')\n```\n\nThe `species_code` function can be called within other `rebird` functions, or the species code \ncan be specified directly.\n\n## eBird Taxonomy\n\nThe eBird taxonomy is internally stored in `rebird` and can be called using\n\n```{r tax}\nrebird::tax\n```\n\nWhile the internal taxonomy is kept up to date with each package release, it could\nbe outdated if a new taxonomy is made available before the package is updated.\nYou can obtain the latest eBird taxonomy by\n\n```{r taxonomy, eval=FALSE}\nnew_tax \u003c- ebirdtaxonomy()\n```\n\n## Sightings at location determined by latitude/longitude\n\nSearch for bird occurrences by latitude and longitude point\n\n```{r ebirdgeo1}\nebirdgeo(species = species_code('spinus tristis'), lat = 42, lng = -76)\n```\n\n## Recent observations at a region\n\nSearch for bird occurrences by region and species name\n\n```{r ebirdregion1}\nebirdregion(loc = 'US', species = 'btbwar')\n```\n\n\n## Recent observations at hotspots\n\nSearch for bird occurrences by a given hotspot\n\n```{r ebirdhotspot}\nebirdregion(loc = 'L99381')\n```\n\n## Nearest observations of a species\n\nSearch for a species' occurrences near a given latitude and longitude\n\n```{r nearestobs}\nnearestobs(species_code('branta canadensis'), 42, -76)\n```\n\n\u003c!--\n## Frequency of observations at hotspots or regions\n\nObtain historical frequencies of bird occurrences by hotspot or region\n\n```{r ebirdfreq}\n# ebirdfreq(loctype = 'hotspots', loc = 'L196159')\n```\n--\u003e\n\n## Recent notable sightings\n\nSearch for notable sightings at a given latitude and longitude\n\n```{r ebirdnotable1}\nebirdnotable(lat = 42, lng = -70)\n```\n\nor a region\n\n```{r ebirdnotable2}\nebirdnotable(locID = 'US-NY-109')\n```\n\n## Historic Observations\n\nObtain a list of species reported on a specific date in a given region \n\n```{r ebirdhistorical1}\nebirdhistorical(loc = 'US-VA-003', date = '2019-02-14',max = 10)\n\n```\n\nor a hotspot\n\n```{r ebirdhistorical2}\nebirdhistorical(loc = 'L196159', date = '2019-02-14', fieldSet = 'full')\n\n```\n\n## Information on a given region or hotspot\n\nObtain detailed information on any valid eBird region\n\n```{r ebirdregioninfo1}\nebirdregioninfo(\"CA-BC-GV\")\n```\n\nor hotspot\n\n```{r ebirdregioninfo2}\nebirdregioninfo(\"L196159\")\n```\n\nObtain a list of eBird species codes for all species recorded in a region\n\n```{r ebirdregionspecies1}\nebirdregionspecies(\"GB-ENG-LND\")\n```\n\nor a hotspot\n\n```{r ebirdregionspecies2}\nebirdregionspecies(\"L5803024\")\n```\n\nObtain a list of all subregions within an eBird region\n\n```{r ebirdsubregionlist}\nebirdsubregionlist(\"subnational1\",\"US\")\n```\n\n## Checklist Feed\n\nObtain a list of checklists submitted on a given date at a region or hotspot\n\n```{r ebirdchecklistfeed}\nebirdchecklistfeed(loc = \"L207391\", date = \"2020-03-24\", max = 5)\n```\n\n## View Checklist\n\nObtain all information on a specific checklist\n\n```{r ebirdchecklist}\nebirdchecklist(\"S139153079\")\n```\n\n## Hotspots in a region or nearby coordinates\n\nObtain a list of hotspots within a region\n\n```{r ebirdhotspotlist1}\nebirdhotspotlist(\"CA-NS-HL\")\n```\n\nor within a radius of up to 50 kilometers, from a given set of coordinates.\n\n```{r ebirdhotspotlist2}\nebirdhotspotlist(lat = 30, lng = -90, dist = 10)\n```\n\n\n## `rebird` and other packages\n\n### How to use `rebird`\n\nThis package is part of a richer suite called [spocc - Species Occurrence Data](https://github.com/ropensci/spocc), along with several other packages, that provide access to occurrence records from multiple databases. We recommend using `spocc` as the primary R interface to `rebird` unless your needs are limited to this single source.\n\n### `auk` vs. `rebird`\n\nThose interested in eBird data may also want to consider [`auk`](https://github.com/CornellLabofOrnithology/auk), an R package that helps extracting and processing the whole eBird dataset. The functions in `rebird` are faster but mostly limited to accessing recent (i.e. within the last 30 days) observations, although `ebirdfreq()` does provide historical frequency of observation data. In contrast, `auk` gives access to the full set of ~ 500 million eBird observations. For most ecological applications, users will require `auk`; however, for some use cases, e.g. building tools for birders, `rebird` provides a quicker and easier way to access data. `rebird` and `auk` are both part of the rOpenSci project.\n\n## API requests covered by `rebird`\n\nThe 2.0 APIs have considerably been expanded from the previous version, and `rebird` only covers some of them.  The webservices covered are listed below; if you'd like to contribute wrappers to APIs not yet covered by this package, feel free to submit a pull request!\n\n### data/obs\n\n- [x] Recent observations in a region: `ebirdregion()`\n- [x] Recent notable observations in a region: `ebirdnotable()`\n- [x] Recent observations of a species in a region: `ebirdregion()`\n- [x] Recent nearby observations: `ebirdgeo()` \n- [x] Recent nearby observations of a species: `ebirdgeo()`\n- [x] Nearest observations of a species: `nearestobs()`\n- [x] Recent nearby notable observations: `ebirdnotable()`\n- [ ] Recent checklists feed\n- [x] Historic observations on a date: `ebirdhistorical()`\n\n### product\n- [ ] Top 100\n- [x] Checklist feed on a date: `ebirdchecklistfeed()`\n- [ ] Regional statistics on a date\n- [x] Species list for a region: `ebirdregionspecies()`\n- [x] View Checklist: `ebirdchecklist()`\n\n### ref/geo\n - [ ]    Adjacent Regions\n\n### ref/hotspot\n - [x] Hotspots in a region: `ebirdhotspotlist()`\n - [x] Nearby hotspots: `ebirdhotspotlist()`\n - [x] Hotspot Info: `ebirdregioninfo()`\n\n### ref/taxonomy\n - [x]     eBird Taxonomy: `ebirdtaxonomy()`\n - [ ]     Taxonomic Forms\n - [x]     Taxonomy Versions: `ebirdtaxonomyversion()`\n - [ ]     Taxonomic Groups\n\n### ref/region\n - [x]     Region Info: `ebirdregioninfo()`\n - [x]     Sub Region List: `ebirdsubregionlist()`\n\n\n## Meta\n\n* Please [report any issues or bugs](https://github.com/ropensci/rebird/issues).\n* License: MIT\n* Get citation information for `rebird` in R doing `citation(package = 'rebird')`\n* Please note that the 'rebird' project is released with a [Contributor Code of Conduct][coc]. By contributing to this project, you agree to abide by its terms.\n\n[![ropensci_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org/)\n\n[coc]: https://github.com/ropensci/rebird/blob/master/CODE_OF_CONDUCT.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci%2Frebird","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropensci%2Frebird","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropensci%2Frebird/lists"}