Search an infrageneric name in a flora list (given a genus name)
Source:R/search_infrageneric_byname.R
search_infrageneric_byname.Rd
This function searches for a given infrageneric.name
in florula.collection
, constraining the search to a given genus.name
and allowing the user to select which attributes to search in.
Usage
search_infrageneric_byname(
infrageneric.name,
genus.name,
attributes.to.search = c("epithet", "subspecies", "variety", "form"),
florula.collection
)
Arguments
- infrageneric.name
A
character
with an infrageneric Latin name to search within a given genus.- genus.name
A
character
with the genus Latin name to which the search should be constrained.- attributes.to.search
A
character
vector with the attributes to search in (any of 'epithet', 'subspecies', 'variety' and 'form').- florula.collection
An
ArangoCollection
containing a flora list.
Value
A list
with the ArangoDocument
s in the florula.collection
from which infrageneric Latin names match the given infrageneric.name
in the attributes.to.search
. The function returns NULL
if no match is found.
Details
The given infrageneric.name
is searched separately in each of the given attributes (one by one), for all ArangoDocument
s that (directly or indirectly) point at the given genus.name
and the results are collected in a list.
Author
Tiago Monteiro-Henriques. E-mail: tmh.dev@icloud.com.