cp_nu_search: Name Usage: Search

In rcol: Catalogue of Life Client

Description

Name Usage: Search

Usage

cp_nu_search(
  q = NULL,
  dataset_key = NULL,
  min_rank = NULL,
  max_rank = NULL,
  content = NULL,
  highlight = NULL,
  reverse = NULL,
  fuzzy = NULL,
  type = NULL,
  nomstatus = NULL,
  status = NULL,
  issue = NULL,
  published_in = NULL,
  facet = NULL,
  sortBy = NULL,
  start = 0,
  limit = 10,
  ...
)

Arguments

q	(character) vector of one or more scientific names
dataset_key	(character) dataset key
min_rank, max_rank	(character) filter by rank. one of: domain, superkingdom, kingdom, subkingdom, infrakingdom, superphylum, phylum, subphylum, infraphylum, superclass, class, subclass, infraclass, parvclass, superlegion, legion, sublegion, infralegion, supercohort, cohort, subcohort, infracohort, magnorder, superorder, grandorder, order, suborder, infraorder, parvorder, superfamily, family, subfamily, infrafamily, supertribe, tribe, subtribe, infratribe, suprageneric name, genus, subgenus, infragenus, supersection, section, subsection, superseries, series, subseries, infrageneric name, species aggregate, species, infraspecific name, grex, subspecies, cultivar group, convariety, infrasubspecific name, proles, natio, aberration, morph, variety, subvariety, form, subform, pathovar, biovar, chemovar, morphovar, phagovar, serovar, chemoform, forma specialis, cultivar, strain, other, unranked
content	(character) one of: 'scientific_name' or 'authorship'
highlight	(logical) TRUE or FALSE. default: NULL
reverse	(logical) TRUE or FALSE. default: NULL
fuzzy	(logical) TRUE or FALSE. default: NULL
type	(character) one of: 'prefix', 'whole_words', 'exact'
nomstatus	(character) filter by nomenclatural status. one of: ok, unavailable, illegitimate, variant, conserved, rejected, doubtful, unevaluated
status	(character) filter by taxonomic status. one of: accepted, doubtful, ambiguous synonym
issue	(character) filter by issue found
published_in	(character) reference id to filter names by
facet	(character) request a facet to be returned. one of: dataset_key, rank, nom_status, status, issue, type, field. facet limit default: 50
sortBy	(character) one of: "relevance", "name", "taxonomic", "index_name_id", or "native"
start	(integer) requested number of offset records. Default: 0
limit	(integer) requested number of maximum records to be returned. Default: 10; max: 1000
...	curl options passed on to verb-GET

Value

list with two slots

• result (data.frame/tibble): results, a zero row data.frame if no results found

• meta (data.frame/tibble): number of results found

Examples

if (cp_up("/nameusage/search?q=Apis")) {
cp_nu_search(q="Apis", limit = 1)
}
## Not run: 
cp_nu_search(q="Agapostemon")
cp_nu_search(q="Agapostemon", dataset_key = 3)
cp_nu_search(q="Agapostemon", min_rank = "genus")
cp_nu_search(q="Agapostemon", nomstatus = "doubtful")
cp_nu_search(q="Agapostemon", status = "accepted")
cp_nu_search(q="Bombus", facet = "rank")
cp_nu_search(q="Agapostemon", dataset_key = 3, hasField="uninomial")

x <- cp_nu_search(q="Poa")
x
x$result
x$result$usage
x$result$usage$name

## End(Not run)

rcol documentation built on July 3, 2021, 1:06 a.m.