get_study_meta: Study Metadata

Description Usage Arguments Details Value Examples

View source: R/studies.R

Description

Retrieve metadata about a study in the Open Tree of Life datastore.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
get_tree_ids(sm)

get_publication(sm)

candidate_for_synth(sm)

get_study_year(sm)

## S3 method for class 'study_meta'
get_tree_ids(sm)

## S3 method for class 'study_meta'
get_publication(sm)

## S3 method for class 'study_meta'
candidate_for_synth(sm)

## S3 method for class 'study_meta'
get_study_year(sm)

get_study_meta(study_id, ...)

Arguments

sm

an object created by get_study_meta

study_id

the study identifier (character)

...

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

Details

get_study_meta returns a long list of attributes for the studies that are contributing to the synthetic tree. To help with the extraction of relevant information from this list, several helper functions exists:

Value

named-list containing the metadata associated with the study requested

Examples

1
2
3
4
5
6
7
8
## Not run: 
req <- get_study_meta("pg_719")
get_tree_ids(req)
candidate_for_synth(req)
get_publication(req)
get_study_year(req)

## End(Not run)

rotl documentation built on Oct. 23, 2020, 8:22 p.m.