getStudyVariableInfoByDataType: (internal) Get meta-info of study numeric or categorical...

In jameslhao/dbgapr_dev: A dbGaP Phenotype Data Organizer

Description

The method returns the variable meta-info of either numeric or categorical variables of the study.

Usage

getStudyVariableInfoByDataType(object, dataType, ...)

## S4 method for signature 'Study,character'
getStudyVariableInfoByDataType(object, dataType,
  ..., dataDicDF = data.frame(), dataStudyOnly = TRUE)

Arguments

object	Study class object.
dataType	a character string. The variable datatype. The possible value is either 'num' (for numeric variable) or 'cat' (for categorical variable).
...	There are optional arguments.
dataDicDF	a data frame. (optional) Dataset data dictionary data.
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 variable meta-info.

Methods (by class)

• object = Study,dataType = character: A method of class Study

Examples

## Not run: 

getStudyVariableInfoByDataType(s, dataType = 'num', dataDicDF = dataDicDF)
getStudyVariableInfoByDataType(s, dataType = 'cat', dataDicDF = dataDicDF)

## End(Not run)

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