Learn R Programming

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

galah

Overview

galah is an R interface to biodiversity data hosted by the Global Biodiversity Information Facility (GBIF) and those members of the GBIF node network that maintain their own APIs (i.e. the ‘living atlases’). 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.

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-R")

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 tibble 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

2.0.2

License

MPL-2.0

Maintainer

Martin Westgate

Last Published

April 12th, 2024

Functions in galah (2.0.2)

galah_group_by

Specify fields to group when downloading record counts
galah_apply_profile

Apply a data quality profile
show_all

Show valid record information
show_values

Show or search for values within a specified field
galah_filter

Narrow a query by specifying filters
slice_head.data_request

Subset first rows of data_request
tidyverse_functions

Non-generic tidyverse functions
galah_geolocate

Narrow a query to within a specified area
galah_identify

Narrow a query by passing taxonomic identifiers
galah_select

Specify fields for occurrence download
print_galah_objects

Print galah objects
search_all

Search for record information
reexports

Objects exported from other packages
collapse_galah

Generate a query
atlas_media

Get metadata on images, sounds and videos
atlas_occurrences

Collect a set of occurrences
atlas_counts

Return a count of records
atlas_species

Collect the set of species observed within the specified filters
collect_media

Collect media files
atlas_taxonomy

Search taxonomic trees
collect_galah

Retrieve a database query
arrange.data_request

Arrange rows of a query
atlas_citation

Generate a citation for occurrence data
galah_call

Start building a query
galah_config

Get or set configuration options that control galah behaviour
compute_galah

Compute a query
galah

Biodiversity Data from the GBIF Node Network
galah_down_to

Deprecated functions