prjConfig: Create user project directory

Description Usage Arguments Value Methods (by class) Examples

Description

The method creates a project directory and saves the path information of the prject directory in a project config file (~/ncbi/dbgapr_conf/prject_config.json). The project directory is where all the data and metadata files are located. Multiple project directories can be created, but only one is defined as the current. An old project directory can be reinstated to become current again.

Usage

1
2
3
4
prjConfig(object, prjDir)

## S4 method for signature 'Commons,character'
prjConfig(object, prjDir)

Arguments

object

Commons class object.

prjDir

a character string. The path to designated project directory.

Value

a logical value. TRUE if the project directory is created and FALSE if not.

Methods (by class)

Examples

1
2
3
4
5
6
## Not run: 

c <- Commons()
prjConfig(c, prjDir = "/home/user/my_project")

## End(Not run)

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