setRefDir {pipeFrame}R Documentation

Set the reference directory

Description

Set the reference directory

Usage

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

setRefDir("./refdir")
getRefDir()
getRef("test")

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


[Package pipeFrame version 1.10.0 Index]