Learn R Programming

⚠️There's a newer version (2.1.1) of this package.Take me there.


galah is an R interface to biodiversity data hosted by the ‘living atlases’; a set of organisations that share a common codebase, and act as nodes of the Global Biodiversity Information Facility (GBIF). These organisations collate and store observations of individual life forms, using the ‘Darwin Core’ data standard. galah was built and is maintained by the Science & Decision Support Team at the Atlas of Living Australia (ALA).

galah enables users to locate and download species occurrence records (observations, specimens, eDNA records, etc.), taxonomic information, or associated media such as images or sounds, and to restrict their queries to particular taxa or locations. Users can specify which columns are returned by a query, or restrict their results to occurrences that meet particular data-quality criteria. All functions return a tibble as their standard format, except atlas_taxonomy which returns tree consisting of Node objects using the data.tree package.

The package is named for the bird of the same name (Eolophus roseicapilla), a widely-distributed endemic Australian species. The logo was designed by Ian Brennan.

If you have any comments, questions or suggestions, please contact us.


Getting started

  • The quick start guide provides an introduction to the package functions.
  • For an outline of the package structure, and a list of all the available functions, run ?galah or view the reference page.

Installation

Install from CRAN:

install.packages("galah")

Install the development version from GitHub:

install.packages("remotes")
remotes::install_github("AtlasOfLivingAustralia/galah")

On Linux you will first need to ensure that libcurl and v8 (version <= 3.15) are installed on your system — e.g. on Ubuntu/Debian, open a terminal and do:

sudo apt-get install libcurl4-openssl-dev libv8-3.14-dev

galah depends on sf for location-based searches. To install galah you will need to make sure your system meets the sf system requirements, as specified here


Cheat sheet


Citations

To generate a citation for the package version you are using, you can run

citation(package = "galah")

If you’re using occurrence data downloaded through galah in a publication, please generate a DOI and cite it. To request a DOI for a download of occurrence record, set mint_doi = TRUE in a call to atlas_occurrences(). To generate a citation for the downloaded occurrence records, pass the data.frame generated to atlas_citation().

# Download occurrence records with a DOI 
occ <- atlas_occurrences(..., mint_doi = TRUE)

# See DOI
attr(occ, "doi")

# Generate citation
atlas_citation(occ)

Copy Link

Version

Install

install.packages('galah')

Monthly Downloads

1,543

Version

1.5.4

License

MPL-2.0

Maintainer

Martin Westgate

Last Published

October 14th, 2023

Functions in galah (1.5.4)

galah_down_to

Specify the lowest taxonomic rank required in a downwards search
galah_identify

Narrow a query by passing taxonomic identifiers
galah_group_by

Specify fields to group when downloading record counts
galah

Biodiversity Data from the Living Atlas Community
galah_geolocate

Narrow a query to within a specified area
galah_config

Get or set configuration options that control galah behaviour
filter.data_request

Narrow a query by specifying filters
galah_apply_profile

Apply a data quality profile
galah_bbox

Narrow a query to within a bounding box
galah_call

Start building a data query
search_identifiers

Search for taxa with taxonomic identifiers
galah_polygon

Narrow a query to within a specified polygon
galah_select

Specify fields for occurrence download
search_all

Search for record information
reexports

Objects exported from other packages
search_media

Search for associated media of occurrence records
show_values

Show or search for values within a specified field
show_all

Show valid record information
select.data_request

Specify fields for occurrence download
search_taxa

Look up taxon information
identify.data_request

Narrow a query by passing taxonomic identifiers
group_by.data_request

Specify fields to group when downloading record counts
slice_head.data_request

Slice for object of class data_request
deprecated

Deprecated functions
atlas_media

Get metadata on images, sounds and videos
atlas_species

Return species lists
atlas_taxonomy

Search taxonomic trees
collect_media

Collect media files
clear_cached_files

Clear previously cached files
atlas_citation

Generate a citation for occurrence data
collect_occurrences

Collect occurrence records from a pre-existing DOI or URL
atlas_occurrences

Return occurrence records
atlas_counts

Return a count of records