rotl (version 3.1.0)

studies_properties: Properties of the Studies

Description

Return the list of study properties that can be used to search studies and trees used in the synthetic tree.

Usage

studies_properties(...)

Value

A list of the study properties that can be used to find studies and trees that are contributing to the synthetic tree.

Arguments

...

additional arguments to customize the API request (see rotl package documentation).

Details

The list returned has 2 elements tree_properties and studies_properties. Each of these elements lists additional arguments to customize the API request properties that can be used to search for trees and studies that are contributing to the synthetic tree. The definitions of these properties are available from https://github.com/OpenTreeOfLife/phylesystem-api/wiki/NexSON

See Also

studies_find_trees

Examples

if (FALSE) {
 all_the_properties <- studies_properties()
 unlist(all_the_properties$tree_properties)
}