R/rqudocuhelper-package.r

#' Helper function for creating documentation based on templates from Qualitas AG.
#'
#' @description
#' Documentation inside Qualitas can be a number of different documents such as
#'
#' \itemize{
#' \item Project plans
#' \item Specifications
#' \item 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.
#'
#' @details
#' It is important to note that the template documents that are coming with this package
#' cannot be compiled with the development version of \code{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 \code{rmarkdown} to the version of CRAN. The
#' GitHub developement version of \code{rmarkdown} is needed when we want to create
#' websites as described on http://rmarkdown.rstudio.com/html_document_format.html
#'
#' @name rqudocuhelper
#' @docType package
NULL
pvrqualitasag/rqudocuhelper documentation built on May 26, 2019, 11:34 a.m.