get_tax {taxnames} | R Documentation |
Get or set a global taxonomy
Description
For convenience and to simplify the call of name formats, the containing object (a taxlist::taxlist object) will be handled internally by all functions.
A standard taxonomic list is already set in this package and can be retrieved or replaced.
The function set_style()
sets the style for the formatted names (default
"markdown"
) and the standard collapse connectors.
Usage
set_tax(tax)
## S3 method for class 'taxlist'
set_tax(tax)
get_tax()
set_style(style, collapse, secundum)
get_style()
Arguments
tax |
A taxlist::taxlist object set as standard taxonomy. |
style |
A character value setting the format style. It is passed to
the homonimous parameter in |
collapse |
A character vector (lenght 1 or 2) setting the collapse
connectors for multiple names. It is passed to the homonimous parameter
in |
secundum |
A character value indicating the name of the colum in slot taxonViews of the internal object, which will be used to indicate the respective taxon view. |
Value
get_tax()
returns an object of class taxlist::taxlist, while
get_style()
returns a list with options set for the session.
Examples
## Get the current taxonomy
get_tax()
## Get further settings
get_style()