tol_about: Information about the Tree of Life

Description Usage Arguments Details Value See Also Examples

View source: R/tol.R View source: R/api-tol.R

Description

Basic information about the Open Tree of Life (the synthetic tree)

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
tol_about(include_source_list = FALSE, ...)

## S3 method for class 'tol_summary'
tax_rank(tax, ...)

## S3 method for class 'tol_summary'
tax_sources(tax, ...)

## S3 method for class 'tol_summary'
unique_name(tax, ...)

## S3 method for class 'tol_summary'
tax_name(tax, ...)

## S3 method for class 'tol_summary'
ott_id(tax, ...)

Arguments

include_source_list

Logical (default = FALSE). Return an ordered list of source trees.

...

additional arguments to customize the API call (see rotl for more information).

tax

an object created with a call to tol_about.

Details

Summary information about the current draft tree of life, including information about the list of trees and the taxonomy used to build it. The object returned by tol_about can be passed to the taxonomy methods (tax_name(), tax_rank(), tax_sources(), ott_id), to extract relevant taxonomic information for the root of the synthetic tree.

Value

An invisible list of synthetic tree summary statistics:

See Also

source_list to explore the list of studies used in the synthetic tree (see example).

Examples

1
2
3
4
5
6
## Not run: 
res <- tol_about()
tax_sources(res)
ott_id(res)
studies <- source_list(tol_about(include_source_list=TRUE))
## End(Not run)

rotl documentation built on May 29, 2017, 6:15 p.m.