getAllDatasetInfo: Get meta-info of all datasets

Description Usage Arguments Value Methods (by class) Examples

Description

The method returns meta-info of all datasets of the studies that have data files available under the project directory.

Usage

1
2
3
4
getAllDatasetInfo(object, ...)

## S4 method for signature 'Commons'
getAllDatasetInfo(object, ..., showAs = "", editor = "")

Arguments

object

Commons class object.

...

There are optional arguments.

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.

Value

a data frame. The meta-info of all datasets available under the project directory.

Methods (by class)

Examples

1
2
3
4
5
6
7
8
## Not run: 

c <- Commons()
getAllDatasetInfo(c)
getAllDatasetInfo(c, showAs = 'json', editor='notepad')
getAllDatasetInfo(c, showAs = 'text', editor='gedit')

## End(Not run)

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