match_taxon_name: Match Dyntaxa taxon names via API

In sharksmhi/SHARK4R: Retrieving, Analyzing, and Validating Marine Data from SHARK and Nordic Microalgae

Match Dyntaxa taxon names via API

Description

This function matches a list of taxon names against the SLU Artdatabanken API (Dyntaxa) and retrieves the best matches along with their taxon IDs.

Usage

match_taxon_name(
  taxon_names,
  subscription_key,
  multiple_options = FALSE,
  searchFields = "Both",
  isRecommended = "NotSet",
  isOkForObservationSystems = "NotSet",
  culture = "sv_SE",
  page = 1,
  pageSize = 100,
  verbose = TRUE
)

Arguments

taxon_names	A vector of taxon names to match.
subscription_key	A character string containing the subscription key for accessing the SLU Artdatabanken API. A key is provided for registered users at Artdatabanken.
multiple_options	Logical. If TRUE, the function will return multiple matching names. Default is FALSE, selecting the first match.
searchFields	A character string indicating the search fields. Defaults to 'Both'.
isRecommended	A character string indicating whether the taxon is recommended. Defaults to 'NotSet'.
isOkForObservationSystems	A character string indicating whether the taxon is suitable for observation systems. Defaults to 'NotSet'.
culture	A character string indicating the culture. Defaults to 'sv_SE'.
page	An integer specifying the page number for pagination. Defaults to 1.
pageSize	An integer specifying the page size for pagination. Defaults to 100.
verbose	Logical. Print progress bar. Default is TRUE.

Details

Note: Please review the API conditions and register for access before using the API. Data collected through the API is stored at SLU Artdatabanken. Please also note that the authors of SHARK4R are not affiliated with SLU Artdatabanken.

Value

A data frame containing the search pattern, taxon ID, and best match for each taxon name.

See Also

SLU Artdatabanken API Documentation

Examples

## Not run: 
# Match taxon names against SLU Artdatabanken API
matched_taxa <- match_taxon_name(c("Homo sapiens", "Canis lupus"), "your_subscription_key")
print(matched_taxa)

## End(Not run)

sharksmhi/SHARK4R documentation built on Jan. 9, 2025, 5:15 p.m.