Skip to contents

Get a name usage (taxon or synonym) by id

Usage

clb_usage(id, dataset = "3LXR", .raw = FALSE)

Arguments

id

Usage id within the dataset.

dataset

Dataset key or alias. Defaults to "3LXR".

.raw

Return the raw parsed JSON instead of a tibble?

Value

A one-row tibble with the usage's id, scientific_name, authorship, rank, status, label, parent_id, extinct, the accepted usage of a synonym (accepted_id, accepted_name), its provenance (origin, dataset_key, sector_key, sector_mode, verbatim_key, verbatim_source_key, merged), further usage fields (name_phrase, according_to, according_to_id, link, remarks, scrutinizer, scrutinizer_id, scrutinizer_date, temporal_range_start, temporal_range_end, ordinal), the list-columns identifier, reference_ids and environments, and the full nested name as a list-column. Fields that do not apply, such as scrutinizer for a synonym, are NA.

scientific_name is the name without its authorship, which is in authorship; label combines both (plus any name_phrase) as shown on ChecklistBank. The values exactly as the source supplied them are in the verbatim record (verbatim_key). id is the usage id within dataset, so it is a COL taxon id only for a COL release. For any other dataset, match its names to get COL ids, see clb_match_checklist().

Examples

if (FALSE) { # \dontrun{
clb_usage("4CGXP", dataset = "3LR")
} # }