getPrjDir: Get user project directory

Description Usage Arguments Value Methods (by class) Examples

Description

The method looks for the current project directory information and associates the directory and its sub-directories to the class object. It returns a list of paths to the current project directory and the sub-directories. The method is called every time when a class object is initialized, which makes the current project directory and the sub-directory information readily accessible through the class object.

Usage

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

## S4 method for signature 'Commons'
getPrjDir(object, ..., showErr = as.logical(F))

Arguments

object

Commons class object.

...

There are optional arguments.

showErr

a logical value. (optional) If TRUE, display the error message; If FALSE (default), not display.

Value

a character list. Current user project directory and the sub-directories.

Methods (by class)

Examples

1
2
3
4
5
6
## Not run: 

c <- Commons()
getPrjDir(c, showErr = TRUE)

## End(Not run)

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