viewStudyVariableInfo: (internal) View study variable meta-info

Description Usage Arguments Methods (by class) Examples

Description

The method displays the meta-info of the variables of either a specified dataset or all variables under the study.

Usage

1
2
3
4
5
viewStudyVariableInfo(object, ...)

## S4 method for signature 'Study'
viewStudyVariableInfo(object, ..., phtAcc = "",
  showAs = "table", editor = "")

Arguments

object

Study class object.

...

There are optional arguments.

phtAcc

a character string. The dbGaP dataset accession.

showAs

a character string. (optional) When the value is 'table', displays the data as a table through a platform specific table viewer; When it is 'json', displays the json text through a plain text editor; When it is 'text', displays in a brief left-justified text format.

editor

a character string. (optional) The name of your favorite plain text editor. It should be executable from a command-line prompt of the respective platform. For example, notepad (Windows), vim, emacs (Unix), gedit (Ubuntu), nedit (CentOS), etc.

Methods (by class)

Examples

1
2
3
4
5
6
## Not run: 

s <- Study(phsAcc = 'phs000001.v3.p1')
viewStudyVariableInfo(s, phtAcc='pht000373.v2', showAs='json')

## End(Not run)

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