asw_sync: Submit query to find updates in nomenclautre

In hcliedtke/AmphiNom: An Amphibian Systematics Tool

Submit query to find updates in nomenclautre

Description

This function takes a query (a list of taxon names to be assessed) and the amphibian species of the world synonym table (preferably generated with the function get_synonyms(), or loaded from the data set stored internally) as input and returns an updated list of names.

Usage

asw_sync(
  query,
  asw = AmphiNom::asw_synonyms,
  interactive = F,
  return.no.matches = F
)

Arguments

query	vector of taxon names to be processed (can also be tip labels of a phylogeny for example)
asw	amphibian species of the world synonym reference table on which to base new names on. Default setting will use the internally stored data set that may not be the most up-to-date.
interactive	logical argument (default=FALSE) of whether to allow an "on the fly" decision to be made on what name to take if synonym matches multiple names. FLASE will return all possible names for a given query as a string, TRUE will ask the user to select one.
return.no.matches	logical argument of whether to leave taxa not found in the reference table blank or whether to fill in the names provided by the query. default is FALSE

Details

Two logical arguments can be turned on to a) allow an "on the fly" decision to be made on what name to take if synonym matches multiple names (if not, it will return all possible names) and to b) return the original query name if no match is found

Value

this function returns a data frame with the following information/columns: original/input names, "stripped" names with no formatting, status of what action has been taken, updated names as recommended by the reference table

Examples

asw_sync(query=c("Bufo calamita", "Bufo viridis"))

hcliedtke/AmphiNom documentation built on Nov. 8, 2024, 8:10 a.m.