rotl: synonyms.match_names – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

synonyms.match_names

List the synonyms for a given name

Description

When querying the Taxonomic Name Resolution Services for a particular taxonomic name, the API returns as possible matches all names that include the queried name as a possible synonym. This function allows you to explore other synonyms for an accepted name, and allows you to determine why the name you queried is returning an accepted synonym.

Usage

## S3 method for class 'match_names'
synonyms(tax, row_number, taxon_name, ott_id, ...)

Arguments

`tax`	a data frame generated by the `tnrs_match_names` function
`row_number`	the row number corresponding to the name for which to list the synonyms
`taxon_name`	the taxon name corresponding to the name for which to list the synonyms
`ott_id`	the ott id corresponding to the name for which to list the synonyms
`...`	currently ignored

Details

To list synonyms for a given taxonomic name, you need to provide the object resulting from a call to the tnrs_match_names function, as well as one of either the row number corresponding to the name in this object, the name itself (as used in the original query), or the ott_id listed for this name. Otherwise, the synonyms for all the currently matched names are returned.

Value

a list whose elements are all synonym names (as vectors of character) for the taxonomic names that match the query (the names of the elements of the list).

Examples

## Not run: 
   echino <- tnrs_match_names(c("Diadema", "Acanthaster", "Fromia"))
   ## These 3 calls are identical
   synonyms(echino, taxon_name="Acanthaster")
   synonyms(echino, row_number=2)
   synonyms(echino, ott_id=337928)

## End(Not run)

rotl

Interface to the 'Open Tree of Life' API

v3.0.11

BSD_2_clause + file LICENSE

Authors

Francois Michonneau [aut, cre] (<https://orcid.org/0000-0002-9092-966X>), Joseph Brown [aut] (<https://orcid.org/0000-0002-3835-8062>), David Winter [aut] (<https://orcid.org/0000-0002-6165-0029>), Scott Chamberlain [rev] (<https://orcid.org/0000-0003-1444-9135>)

Initial release