Skip to contents

Add common (vernacular) names

Source: R/add-common-names.R
add_common_names.Rd

Joins vernacular names to a taxify() result by looking up accepted_name, filtered by language.

Usage

add_common_names(x, lang = "en", cols = NULL, verbose = TRUE)

Arguments

x

A data.frame returned by taxify().

lang

Character. ISO 639-1 language code (e.g., "en", "de", "fr"), or NA to return names without a language tag (NCBI/OTT sources). Default "en". List the languages present with enrichment_groups("common_names").

cols

Which columns to attach. NULL (the default) attaches the curated set; a character vector of column names attaches just those, and "all" attaches every column the source carries (see enrichment_cols()).

verbose

Logical. Default TRUE.

Value

The same data.frame with an additional column:

common_name

The vernacular name in the requested language, or NA if none is available.

Details

Common names are merged from three sources:

  • GBIF backbone vernacular names (CC0) — multi-language via ISO 639-1 codes.

  • NCBI Taxonomy common names (public domain) — no language tag (lang = NA).

  • Open Tree of Life common names (CC0) — no language tag (lang = NA).

When multiple common names exist for a species in the requested language, the first (most commonly used) is returned.

Examples

# Runs offline against the bundled example database.
old <- options(taxify.data_dir = taxify_example_data())

taxify("Quercus robur") |>
  add_common_names()

taxify("Quercus robur") |>
  add_common_names(lang = "de")

options(old)