In Amarakon55/amaRyaml: AmaRYAML

library(knitr)
opts_chunk$set(echo = FALSE, cache = TRUE)

Description

R package which includes a suite of custom R Markdown templates. Most of these templates use LaTeX, GitHub is the exception. These templates are useful due to them having common information in the YAML header. They also include global R options that are helpful. I use them so I don't have to define them each time I create a new R Markdown file.

Templates

There are currently four templates available in this package:

one = c("![Book](examples/book/book.png)")
two = c("![Eisvogel](examples/eisvogel/eisvogel.png)")

templates = data.frame(one, two)

kable(templates, 'pipe', align = 'cc', col.name = c("[Book](examples/book/book.pdf)", "[Eisvogel](examples/eisvogel/eisvogel.pdf)"))

one = c("![GitHub](examples/github/github.png)")
two = c("![NorBeam](examples/norbeam/norbeam.png)")

templates = data.frame(one, two)

kable(templates, align = 'cc', col.name = c("[GitHub](examples/github/github.md)", "[NorBeam](examples/norbeam/norbeam.pdf)"))

one = c("![Leaflet [1/2]](examples/leaflet/leaflet-1.png)")
two = c("![Leaflet [2/2]](examples/leaflet/leaflet-2.png)")

templates = data.frame(one, two)

kable(templates, align = 'cc', col.name = c("[Leaflet [1/2]](examples/leaflet/leaflet.pdf)", "[Leaflet [2/2]](examples/leaflet/leaflet.pdf)"))

GitHub

The GitHub template uses a pandoc lua filter script named lower-header.lua. This simple script only occupies four lines of code. Its purpose is to make each section header one level lower. For example: level one headers (#) will be turned to level two headers (##), and so on.

Installation

The amaryaml package is currently only available from GitHub. You need the remotes package to install from GitHub:

install.packages("remotes")
remotes::install_github("Amarakon55/amaryaml")

This package requires LaTeX for most templates. The tinytex package makes it easy to setup LaTeX within R:

install.packages("tinytex")
tinytex::install_tinytex()

Usage

Using AmaRYAML is very easy. There are two main ways to do so:

1. selecting a template in RStudio using the R Markdown template selector

2. creating a new draft with the rmarkdown::draft() function

3. rmarkdown::draft("file.Rmd", "book", "amaryaml")

4. rmarkdown::draft("file.Rmd", "eisvogel", "amaryaml")
5. rmarkdown::draft("file.Rmd", "github", "amaryaml")
6. rmarkdown::draft("file.Rmd", "norbeam", "amaryaml")

Amarakon55/amaRyaml documentation built on Aug. 14, 2022, 11:45 a.m.