getDatasetMetaByStudy: (internal) Get study variable meta-info (data dictionary)

In jameslhao/dbgapr_dev: A dbGaP Phenotype Data Organizer

Description

The method returns the meta-info of all datasets of the given study.

Usage

getDatasetMetaByStudy(object, phsAcc, ...)

## S4 method for signature 'Commons,character'
getDatasetMetaByStudy(object, phsAcc)

Arguments

object	Commons class object.
phsAcc	a character string. The dbGaP study accession.
...	There are optional arguments.
dataStudyOnly	a logical value. When TRUE (default), only downloads the dataset and variable metadata of the stdudies that have data files in the project directory. When FALSE, downloads the dataset and variable metadata of all dbGaP released studies, regardless the actual phenotype data files of the studies are downloaded or not.

Value

a data frame. The dataset meta-info of the study.

Methods (by class)

• object = Commons,phsAcc = character: A method of class Commons

Examples

## Not run: 

c <- Commons()
getDatasetMetaByStudy(c, phsAcc = 'phs000001.v3.p1')

## End(Not run)

jameslhao/dbgapr_dev documentation built on May 8, 2019, 11:03 p.m.