In charlotte-ngs/rmddochelper:

knitr::opts_chunk$set(echo = FALSE, results = 'asis')

r6obj_docstat <- rmddochelper::R6ClassDocuStatus$new()
r6obj_docstat$set_current_status(psVersion = "0.0.901",
                                 psStatus = "Initialisation",
                                 psProject = "rmddochelper")
r6obj_docstat$set_current_status(psVersion = "0.0.902",
                                 psStatus = "Extending project status",
                                 psProject = "rmddochelper")

r6obj_docstat$include_doc_stat(psTitle = "## Document Status")

r6ob_abbrtable <- rmddochelper::R6ClassTableAbbrev$new()
r6ob_abbrtable$include_abbr_table(psAbbrTitle = "## Abbreviations")

Disclaimer

This document contains the user manual for package rmddochelper.

Introduction

The toolchain with Rstudio, rmarkdown, knitr and pandoc provides very good support to create r r6ob_abbrtable$add_abbrev(psAbbrev = "rmd", psMeaning = "R Markdown") documents. Users interact with this toolchain via the r r6ob_abbrtable$add_abbrev(psAbbrev = "GUI", psMeaning = "Graphical User Interface") provided by RStudio. The package rmddochelper is thought to support the above toolchain for users who are more used to a command-based r r6ob_abbrtable$add_abbrev(psAbbrev = "UI", psMeaning = "User Interface"). With command-based UI we mean that the user interfaces or communicates with programs by function calls that are given to an interpreter such as R on a commandline. This command-based UI apporach is opposed to the GUI based approach where programs are driven by interaction of the mouse with graphical elements such as buttons and menues.

The advantage of the command-based approach is its scalability and its reproducability. Scalability means that it takes about the same amount of resources independent of how many documents we create. This can be achieved using a command-based approach, it takes about the same amount of resources whether I create one or ten documents on the command line. With GUI-based approaches the amount of resources increases linearly with the number of documents that I want to create.