Function reference • litr

Primary functions

These are the functions you’ll use the most.

draft(): Create a new litr .Rmd document for creating an R package

render(): Render R markdown file

document(): Use roxygen to document a package from within a Rmd file

load_all(): Load complete package

Working from template

These are functions for quickly creating different kinds of R packages.

draft(): Create a new litr .Rmd document for creating an R package

draft_bookdown(): Create a new litr .Rmd document for creating an R package from bookdown

draft_data(): Create a new litr .Rmd document for creating an R package with a data set

draft_rcpp(): Create a new litr .Rmd document for creating an R package that uses Rcpp

draft_extras(): Create a new litr .Rmd document for creating an R package with extras

draft_armadillo(): Create a new litr .Rmd document for creating an R package that uses RcppArmadillo

Functions for adding “extras” to your package

These functions can help you add a README, vignettes, a pkgdown site, and a hex sticker to your package.

add_readme(): Add README to package

add_vignettes(): Add one or more vignettes to package

add_pkgdown(): Add a pkgdown site

add_hex_sticker(): Add a hex sticker to package

Custom output formats

These are the functions for producing different output formats.

litr_html_document(): litr version of rmarkdown::html_document()

litr_pdf_document(): litr version of rmarkdown::pdf_document()

litr_gitbook(): litr version of bookdown::gitbook()

litrify_output_format(): Modify an existing output format to have litr behavior