taxon_names: Handle Information on Taxon Usage Names

Description

The slot 'taxonNames' in '>taxlist objects contains taxon usage names for the respective taxon. These functions assist on the access and modification of entries for names.

Usage

# S4 method for taxlist
taxon_names(taxlist, ...)
taxon_names(taxlist) <- value
# S4 method for taxlist
add_synonym(taxlist, ConceptID, TaxonName, AuthorName, ...)
# S4 method for taxlist,numeric
update_name(taxlist, UsageID, ...)
# S4 method for taxlist,numeric
delete_name(taxlist, UsageID, ...)

Arguments

taxlist

A '>taxlist object to be modified.

value

A data frame used as new slot 'taxonNames' in 'taxlist'.

ConceptID

Numeric vector indicating the concept ID to which the synonyms will be added.

TaxonName,AuthorName

Character values used for the new names (synonyms).

UsageID

Numeric vector indicating the taxon usage IDs to be updated.

...

Further arguments passed among methods. In 'update_name' are vectors including the variables to be updated for the respective taxon usage ID.

Value

A data frame or, in the case of the replacement method, a '>taxlist object with modified slot 'taxonNames'.

Details

The replacement method 'taxon_names<-' is a quick alternative to include names in empty '>taxlist objects.

The function 'add_synonym' works only for adding names to existing taxon concepts. For adding new taxon concepts as well you should use add_concept.

Examples

Run this code

# NOT RUN {
library(taxlist)
data(Easplist)

## Display of slot 'taxonNames'
Euclea <- subset(Easplist, charmatch("Euclea", TaxonName), slot="names",
	keep_children=TRUE)
summary(Euclea)
taxon_names(Euclea)

## Insert a synonym to Diospyros scabra
summary(Easplist, "Diospyros scabra")
Easplist <- add_synonym(Easplist, 51793, TaxonName="Maba scabra",
	AuthorName="Chiov.")
summary(Easplist, "Diospyros scabra")

## Delete a synonym of Launaea cornuta
summary(Easplist, "Launaea cornuta")
Easplist <- delete_name(Easplist, 53821)
summary(Easplist, "Launaea cornuta")
# }