Skip to contents

Navigate the taxonomic tree

Source: R/tree.R
clb_tree.Rd

Without id, returns the root taxa of the dataset's tree. With id, returns the path (lineage) from the root down to that taxon. Use clb_children() to descend one level.

Usage

clb_tree(
  dataset = "3LXR",
  id = NULL,
  extinct = TRUE,
  ...,
  limit = 100L,
  max = limit,
  .raw = FALSE
)

Arguments

dataset

Dataset key or alias. Defaults to "3LXR".

id

Optional taxon id. When omitted the tree roots are returned.

extinct

Logical; include extinct taxa. Defaults to TRUE.

...

Further query parameters (e.g. insertPlaceholder).

limit

Page size when listing roots.

max

Maximum number of roots to return.

.raw

Return the raw parsed JSON instead of a tibble?

Value

A tibble of tree nodes with columns such as id, name, authorship, rank, status, childCount and count.

See also

clb_children(), clb_classification()

Examples

if (FALSE) { # \dontrun{
clb_tree(dataset = "3LR")            # kingdoms / roots
clb_tree(dataset = "3LR", id = "4CGXP")  # lineage of a taxon
} # }