cp_nu_suggest: Name Usage: Suggest

In rcol: Catalogue of Life Client

Description

Name Usage: Suggest

Usage

cp_nu_suggest(
  q,
  dataset_key,
  fuzzy = FALSE,
  min_rank = NULL,
  max_rank = NULL,
  sort = NULL,
  reverse = FALSE,
  accepted = FALSE,
  limit = 10,
  ...
)

Arguments

q	(character) main query string. required
dataset_key	(character) a dataset key. required
fuzzy	(logical) Whether or not to do fuzzy search (default: FALSE)
min_rank, max_rank	(character) See rank options in cp_name_match()
sort	(character) one of name, taxonomic, index_name_id, native, relevance
reverse	(logical) reverse order i assume (default: FALSE)
accepted	(logical) limit to accepted names (default: FALSE)
limit	(integer) requested number of maximum records to be returned. Default: 10; max: 1000
...	curl options passed on to crul::verb-GET

Value

a data.frame/tibble of results. a zero row data.frame if no results

Examples

if (cp_up("/dataset/3/nameusage/suggest?q=Apis")) {
cp_nu_suggest(q="Apis", 3)
}

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