Skip to contents

Like clb_match() but requests verbose output and returns the matched usage together with all alternative candidates, one per row.

Usage

clb_match_verbose(
  name,
  authorship = NULL,
  rank = NULL,
  code = NULL,
  dataset = "3LXR",
  server = NULL,
  .raw = FALSE
)

Arguments

name

Scientific name to match. May include the authorship, or supply it separately via authorship.

authorship

Optional authorship string.

rank

Optional rank to disambiguate (e.g. "species", "genus").

code

Optional nomenclatural code ("zoological", "botanical", "bacterial", "virus", ...).

dataset

Dataset key or alias to match against. Defaults to "3LXR". See clb_col_release() for the COL release aliases.

server

Optional base URL of an alternative matching service, e.g. a locally running dockerized matching container ("http://localhost:8080"). Overrides CLB_BASE_URL for this call.

.raw

Return the raw parsed JSON response instead of a tibble?

Value

A tibble of candidate usages with a logical primary column flagging the chosen match. Zero rows when nothing matched.

See also

Examples

if (FALSE) { # \dontrun{
clb_match_verbose("Oenanthe")
} # }