R6RmdDocInfo: R6 Class Representing Rmarkdown Document Objects

In charlotte-ngs/rmddochelper:

Description

Rmarkdown documents which include information that is distributed over several files are ideally put into a single parent directory. For organisational reasons, it is easier to put the different files included in a Rmarkdown document into different subfolders according to their file-type. This structure is constant, except for the name of the Rmarkdown file which can easily be parameterized.

Usage

R6RmdDocInfo$new()

Format

An object of class R6ClassGenerator of length 24.

Value

R6 Object of type R6RmdDocInfo

Fields

docName

Name of the document project

rmdPath

Path where rmd-files are stored

figPath

Path where figure source files are stored

pngPath

Path where figure files that should be included in the document are stored

Public methods

new()

Instantiation of R6 object of class R6RmdDocInfo

setDocName(psDocName)

setter for document project name

getDocPath

getter for field docName

setRmdPath(psRmdPath)

setter for field rmdPath

getRmdPath

getter for field rmdPath

setFigPath(psFigPath)

setter for field figPath

getFigPath

getter for field figPath

setPngPath(psPngPath)

setter for field pngPath

getPngPath

getter for field pngPath

Examples

r6objDocInfo <- R6RmdDocInfo$new(psDocName = "MyFirstRmdDoc")

charlotte-ngs/rmddochelper documentation built on June 27, 2019, 1:22 a.m.