setRefDir: Set the reference directory

Description Usage Arguments Value Examples

View source: R/configVal.R

Description

Set the reference directory

Usage

1
2
3
4
5
6
7
8
9
setRefDir(refdir, createDir = TRUE)

getRefDir()

getRef(refName)

getRefFiles(refName)

getRefRc(refName)

Arguments

refdir

Character scalar. The directory to store the reference data.

createDir

Logica scalar. Create the directory if the directory does not exist. Default: TRUE

refName

Character scalar. The name of reference data.

Value

setRefDir

No value will be returned

getRefDir

Character scalar. Display the directory of reference data.

getRef

List scalar. A list object which contains "files" (reference file paths) and "rc" (reference R object)

getRefFiles

Character scalar or vector. Display the reference file directory.

getRefRc

Uncertain scalar or vector. Display any reference R object.

Examples

1
2
3
4
5
6
setRefDir("./refdir")
getRefDir()
getRef("test")

getRefFiles("test")
getRefRc("test")

pipeFrame documentation built on Nov. 8, 2020, 5:51 p.m.