R/knitrengines-package.r

In hrbrmstr/knitrengines: Collection of Language Engines for Use with the 'knitr' Package

#' A package to collect and seamlessly add knitr engines to knitr
#'
#' The knitr package already has support for a
#' \href{https://www.rforge.net/doc/packages/knitr/knit_engines.html}{plethora}
#' of languages besides \code{R} code chunks (26 as of the last update to this
#' package). That is probably sufficient for the vast majority of users.
#'
#' However, if you need to perform some processing in another languages and want
#' to include it in your reproducible workflow, this package will allow you to
#' incorporate those language code chunks provided there is a matching knitr
#' language processor available.
#'
#' To use one of these alternate code chunks, just ensure you have a call to
#' \code{library(knitrengines)} at in an R code chunk at the top of your R
#' markdown file then use one of the available engines via the short name below
#' as the package will auto-register them on attach.
#'
#' This package contains support for the following engines:
#'
#' \describe{
#'   \item{\code{go}}{Go language support}
#'   \item{\code{elixir}}{Elixir language support}
#' }
#'
#' You can contribe to the project on GitHub and add support for other language
#' code chunks. The only real downside is that these language chunks do not have
#' access to the variables in/across chunks, so you have to export the data from
#' previous chunks to files (or databases, etc.) to access it (if needed).
#'
#' Before you go creating other engines, these are the ones knitr already
#' supports: awk, bash, coffee, gawk, groovy, haskell, node, perl, python,
#' Rscript, ruby, sas, scala, sed, sh, zsh, highlight, Rcpp, tikz, dot, c,
#' fortran, asy, cat, asis, stan.
#'
#' @name knitrengines
#' @docType package
#' @author Bob Rudis (@@hrbrmstr)
#' @import knitr
NULL