Searches name usages within a dataset (defaults to the latest extended COL
release). The accepted/synonym usage fields are hoisted to top-level columns
as in clb_usage(), including origin and the sector keys; the taxonomic
classification and full name object are kept as list-columns.
Usage
clb_usage_search(
q = NULL,
dataset = "3LXR",
rank = NULL,
status = NULL,
...,
limit = 50L,
max = limit
)
clb_search(
q = NULL,
dataset = "3LXR",
rank = NULL,
status = NULL,
...,
limit = 50L,
max = limit
)Arguments
- q
Free-text query. Optional (omit to browse with filters only).
- dataset
Dataset key or alias. Defaults to
"3LXR".- rank
Filter by rank (e.g.
"species").- status
Filter by taxonomic status (e.g.
"accepted","synonym").- ...
Further query parameters forwarded to the search endpoint (e.g.
extinct,nomCode,minRank,maxRank,type).- limit
Page size per request.
- max
Maximum number of usages to return. Use
Infto fetch all.
Value
A clb object: a list with $data (a tibble of
usages) and $meta (with total). Besides the columns described in
clb_usage(), $data has group, sector_dataset_key,
sector_publisher_key, the list-columns secondary_source_keys and
secondary_source_groups, and classification.
Usage ids are those of dataset. To link the usages of a checklist to
COL taxon ids, pass $data to clb_match_checklist() with
name = "scientific_name".