Search an infraspecific name in a flora list (given a species name)
Source:R/search_infraspecific_byname.R
search_infraspecific_byname.Rd
This function searches for a given infraspecific.name
in florula.collection
, constraining the search to a given species name (i.e a genus.name
+ epithet.name
) and allowing the user to select which attributes to search in.
Usage
search_infraspecific_byname(
infraspecific.name,
genus.name,
epithet.name,
attributes.to.search = c("subspecies", "variety", "form"),
florula.collection
)
Arguments
- infraspecific.name
A
character
with an infraspecific Latin name to search within a given species (genus + epithet).- genus.name
A
character
with the genus Latin name to which the search should be constrained.- epithet.name
A
character
with the specific epithet to which the search should be constrained.- attributes.to.search
A
character
vector with the attributes to search in (any of '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 infraspecific Latin names match the given infraspecific.name
in the attributes.to.search
. The function returns NULL
if no match is found.
Details
The given infraspecific.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 species and the results are collected in a list.
Author
Tiago Monteiro-Henriques. E-mail: tmh.dev@icloud.com.