Learn R Programming

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

galah


galah is an R interface to biodiversity data hosted by the Atlas of Living Australia (ALA). It 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 ALA is an aggregator of biodiversity data, focussed primarily on observations of individual life forms. Like the Global Biodiversity Information Facility (GBIF), the basic unit of data at ALA is an occurrence record, based on the 'Darwin Core' data standard.

The galah 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 vignette 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

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.4.0

License

MPL-2.0

Issues

Pull Requests

Stars

Forks

Maintainer

Martin Westgate

Last Published

January 24th, 2022

Functions in galah (1.4.0)

atlas_taxonomy

Search taxonomic trees
clear_cached_files

Clear previously cached files
atlas_occurrences

Occurrence records
galah

Download biodiversity data from the Atlas of Living Australia
deprecated

Deprecated functions
atlas_media

Download images, sounds and videos
atlas_species

Return species lists
atlas_citation

Generate a citation for occurrence data
atlas_counts

Return a count of records
galah_call

Start building a data query
galah_config

Get or set configuration options that control galah behaviour
galah_filter

Narrow a query by specifying filters
search_profile_attributes

Search for which quality filters are applied by a data quality profile
show_all_atlases

List supported Living Atlases
search_identifiers

Search for taxa with taxonomic identifiers
search_taxa

Taxon information
search_field_values

Search for valid options of a categorical field
galah_select

Specify fields for occurrence download
show_all_cached_files

List previously cached files
search_fields

Query layers, fields or assertions by free text search
galah_geolocate

Narrow a query using a WKT string
galah_identify

Narrow a query by passing taxonomic identifiers
galah_group_by

Specify fields to group when downloading record counts
galah_down_to

Specify the lowest taxonomic rank required in a downwards search
show_all_reasons

List valid download reasons
show_all_profiles

List data quality profiles
show_all_ranks

Find valid taxonomic ranks