Documentation inside Qualitas can be a number of different documents such as
Project plans
Specifications
Implementation documents
Most of the documentations are just one source text file and sometimes a few source files for diagrams. Hence, it is debatable whether the documentation should be embedded into complete R packages. The big advantage of doing everything in a R package is the absolute standardization and the uniformness with which everything can be dealt with. A negative point is the overhead coming with a R package, that means to put a lot of infrastructure into place that is not used.
The goal of this package is to fill in some blanks in constructing documentation and in managing the documents during their lifetime.
It is important to note that the template documents that are coming with this package
cannot be compiled with the development version of rmarkdown
which comes from
GitHub. Due to this package dependency, the whole project was converted into a packrat
project, where we can keep the package rmarkdown
to the version of CRAN. The
GitHub developement version of rmarkdown
is needed when we want to create
websites as described on http://rmarkdown.rstudio.com/html_document_format.html
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.