viewAllStudyInfo: (internal) Display meta-info of all studies

In jameslhao/dbgapr_dev: A dbGaP Phenotype Data Organizer

Description

The method displays the meta-info of all studies available in the project directory. The display is through a separate a table viewer or a plain text editor intended for human to browse and search. This function is called through getAllStudyInfo.

Usage

viewAllStudyInfo(object, ...)

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

Arguments

object	Commons class object.
...	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.

Methods (by class)

• Commons: A method of class Commons

Examples

## Not run: 

c <- Commons()
viewAllStudyInfo(c)
viewAllStudyInfo(c, showAs = 'table', editor = 'notepad')
# or
viewAllStudyInfo(c, showAs = 'json', editor = 'notepad')
# or
viewAllStudyInfo(c, showAs = 'text', editor = 'gedit')

## End(Not run)

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