use_study: Get data for a given study ID

Description Usage Arguments Details Examples

Description

Get data for a given study ID

Usage

1
use_study(id, defin = FALSE, guess_max = -1)

Arguments

id

the study ID - this can either be a short ID or long ID which are found in the ID columns of the result of get_study_list or get_study_list_anthro

defin

boolean specifying whether to read in the data definition instead of the data - default is FALSE

guess_max

parameter passed on to read_csv

Details

This function takes a study ID and if there is not a git repository checked out for it, it will check out the respository and read and return the appropriate data file. If the repository is checked out, it will pull any updates to the data and then read and return the appropriate data file. In the case of study IDs associated with get_study_list_anthro, the correct data will be returned. In the case of study IDs not in this list but in get_study_list, a guess will be made as to which data file is appropriate.

Examples

1
2
3
4
5
## Not run: 
studies <- get_study_list_anthro()
wsb <- use_study("wsb")

## End(Not run)

HBGDki/ghap documentation built on May 6, 2019, 9:45 p.m.