search_guids: Lookup of species identifiers

In AtlasOfLivingAustralia/ALA4R: Atlas of Living Australia (ALA) Data and Resources in R

Description

Provides names, taxonomic classification, and other information for a list of GUIDs.

Usage

search_guids(guids = c(), occurrence_count = FALSE, output_format = "simple")

Arguments

guids	string: a single GUID or vector of GUIDs
occurrence_count	logical: if TRUE then also return the number of occurrences of each matched GUID. Note that this requires one extra web call for each GUID, and so may be slow.
output_format	string: controls the print method for the returned object. Either "complete" (the complete data structure is displayed), or "simple" (a simplified version is displayed). Note that the complete data structure exists in both cases: this option only controls what is displayed when the object is printed to the console. The default output format is "simple"

Value

A data frame, which should include one entry (i.e. one data.frame row or one list element) per input GUID. The columns in the data.frame output may vary depending on the results returned by the ALA server, but should include searchTerm, name, rank, and guid.

References

The associated ALA web service: https://api.ala.org.au/#ws87

Examples

## Not run: 
search_guids(c("urn:lsid:biodiversity.org.au:afd.taxon:
95773568-053d-44de-a624-5699f0ac4a59",
  "http://id.biodiversity.org.au/node/apni/2890970",
  "this_is_not_a_valid_guid"))

## End(Not run)

AtlasOfLivingAustralia/ALA4R documentation built on Sept. 16, 2021, 4:33 a.m.