get_cohorts {quincunx} | R Documentation |
Get PGS Catalog Cohorts
Description
Retrieves cohorts via the PGS Catalog REST API. Please note that all
cohort_symbol
is vectorised, thus allowing for batch mode search.
Usage
get_cohorts(
cohort_symbol = NULL,
verbose = FALSE,
warnings = TRUE,
progress_bar = TRUE
)
Arguments
cohort_symbol |
A cohort symbol or |
verbose |
A |
warnings |
A |
progress_bar |
Whether to show a progress bar indicating download progress from the REST API server. |
Value
A cohorts object.
Examples
# Get information about specific cohorts by their symbols (acronyms)
get_cohorts(cohort_symbol = c('23andMe', 'IPOBCS'))
# Get info on all cohorts (may take a few minutes to download)
## Not run:
get_cohorts()
## End(Not run)
[Package quincunx version 0.1.7 Index]