R6ClassEnum: R6 Class representing enumerations

In charlotte-ngs/rmddochelper:

Description

Simple R6 class allowing to include enumeration objects in documents. The document formats must allow for R-code-junks to be executed, as e.g. with rmarkdown or rnoweb documents. The enumeration objects are initialized at the beginning of the document and whenever an enumeration object is needed an inline R-statement is used to generate the required enumeration instance.

Usage

R6ClassEnum$new()

Format

An object of class R6ClassGenerator of length 24.

Fields

count

enumeration count

Public methods

new()

Instantiation of enumeration object

setCount(pnCount)

setter for count field

getCount()

getter for count field

incrCount()

increment count by one

incrCountByN(pnIncr)

increment count by pnIncr

out()

output count

Examples

# generate a new enumeration object
en <- rmddochelper::R6ClassEnum$new()
# increment number
en$incrCount()
# output of count
en$out()

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