Skip to contents

Search AlgaeBase for Information About a Genus of Algae

Source: R/algaebase_api_functions.R
get_algaebase_genus.Rd

This function searches the AlgaeBase API for genus information and returns detailed taxonomic data, including higher taxonomy, taxonomic status, scientific names, and other related metadata.

Usage

get_algaebase_genus(
  genus,
  apikey,
  higher = TRUE,
  unparsed = FALSE,
  newest_only = TRUE,
  exact_matches_only = TRUE
)

Arguments

genus

The genus name to search for (character string). This parameter is required.

apikey

A valid API key for AlgaeBase (character string). This is required to authenticate API requests.

higher

A boolean flag indicating whether to include higher taxonomy in the output (default is TRUE).

unparsed

A boolean flag indicating whether to return the raw JSON output from the API (default is FALSE).

newest_only

A boolean flag to return only the most recent entry (default is TRUE).

exact_matches_only

A boolean flag to limit results to exact matches (default is TRUE).

Value

A data frame containing taxonomic data from AlgaeBase. Columns may include: - id: AlgaeBase ID. - accepted_name: Accepted scientific name (if different from input). - input_name: The genus name supplied by the user. - input_match: Whether the genus exactly matches (1 if exact, 0 if not). - currently_accepted: Whether the taxon is currently accepted (1=TRUE, 0=FALSE). - genus_only: Whether the search was for a genus only (1 for genus, 0 for genus + species). - kingdom, phylum, class, order, family: Higher taxonomy (if higher is TRUE). - taxonomic_status: Status of the taxon (currently accepted, synonym, unverified). - taxon_rank: The taxonomic rank of the accepted name (e.g., genus, species). - mod_date: Date when the entry was last modified. - long_name: Full scientific name including author and date (if available). - authorship: Author information (if available).

Examples

if (FALSE) { # \dontrun{
  get_algaebase_genus("Anabaena", apikey = "your_api_key")
} # }