variableSummary: Variable data summary

Description Usage Arguments Value Methods (by class) Examples

Description

The method returns the statistical summary of a given variable of the class study. The statistical summary is also displayed along with the variable meta-info.

Usage

1
2
3
4
5
variableSummary(object, phvAcc, ...)

## S4 method for signature 'Study,character'
variableSummary(object, phvAcc, ...,
  emptyToNa = FALSE)

Arguments

object

Study class object.

phvAcc

a character string. The dbGaP variable accessions

...

There are optional arguments.

emptyToNa

a logical value. (optional) If TRUE, converts the empty value to NA. Not convert if FALSE (default).

Value

a data frame. The statistical summary data.

Methods (by class)

Examples

1
2
3
4
5
6
## Not run: 

s <- Study(phsAcc = 'phs000001.v3.p1')
variableSummary(s, phvAcc = 'phv00054119.v1.p1.c2')

## End(Not run)

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