Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sebastiansauer/yart

RMarkdown Template for writing PDF reports
https://github.com/sebastiansauer/yart

academic latex pandoc-templates pdf r react rmarkdown rmarkdown-template

Last synced: about 22 hours ago
JSON representation

RMarkdown Template for writing PDF reports

Awesome Lists containing this project

README 

        
[![Package-License](http://img.shields.io/badge/license-GPL--3-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-3.0.html) [![Project Status: WIP - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)



## Yart: Yet another markdown report template



## What is Yart?



It would be useful to have a RMarkdown template for typical (academic) reports such as class assignments and bachelor/master thesises. The LaTeX class "report" provides a suitable format for that. This package provides a simple wrapper around this class built on the standard pandoc template.



This package leans on earlier work by [Aaron Wolen](http://aaronwolen.com/) in his

[pandoc-letter](https://github.com/aaronwolen/pandoc-letter) repository, and extends it for use from

R via the [rmarkdown](https://cran.r-project.org/package=rmarkdown) package. The structure of this package is heavily inspired by Dirk Eddelbuettel's nice template package [linl](https://github.com/eddelbuettel/linl).



The following screenshot shows on the left hand side the raw markdown file and on the right hand side the compiled pdf paper.



![](https://raw.githubusercontent.com/sebastiansauer/yart/master/docs/yart_screenshot.png)



## Features



Being built on Pandoc, yart provides the typical features of Pandoc's Markdown, inculding citation, figures, tables and references thereto -- and basically, via a template, the fully featured LaTeX beauty. Being built on RMarkdown/knitr, R can be knitted into the text document.



The specific addon of this template is that it configurates a LaTeX template suitable for (academic) reports so that the user does not have to deal with the LaTeX peculiarities and can focus on writing/contents. There are a number of levers which can be adapted by the used in the yart template including author name, title, subtitle, address, date, referee's name, assignment name, school's name, due date.



## Installation



Install via R from Github:



```r

# install.packages("devtools", dependencies = TRUE)

devtools::install_github("sebastiansauer/yart")

```



Be careful with `build_vignettes = TRUE` as it may provoke errors. To build vignettes, I recommend the R function `devtools::build_vignettes()`. Per default, no vignettes are built by `install_github()`, malheuresement.



## Dependencies



- [R](https://cran.r-project.org/) 

- [RStudio Desktop](https://www.rstudio.com/products/rstudio/download/) (not strictly necessary, but recommended)

- [LaTeX](https://www.latex-project.org/get/)

- packages: rmarkdown and its dependencies (to be installed via R)



>   Please use the most recent versions of each software.



## Example



### Skeleton



The skeleton creates a very simple letter.



Several formatting defaults are in use. See `help(yart)` for a

complete list and default values.



### Vignette



You can download the vignette [here](https://github.com/sebastiansauer/yart/raw/master/vignettes/examples/yart.pdf).



## Usage - as a RStudio template



First, open as a Markdown template via RStudio via *File > New File > RMarkdown > From Template > YART*. The template list or Rmarkdown should feature the YART template upon the package installation:



![](https://raw.githubusercontent.com/sebastiansauer/yart/master/docs/yart_template_rstudio.png)



Second, "knit" to document to pdf:



![](https://raw.githubusercontent.com/sebastiansauer/yart/master/docs/knit_to_yart.png)



or use code such as



```r

library(rmarkdown)

draft("my_report.Rmd", template="pdf", package="yart", edit=FALSE)

render("my_report.Rmd")

```



to create a first draft of a new `my_report.Rmd`.   



## Usage - as a pandoc template



Open the file [yart-via-template.Rmd](./yart-via-template.Rmd), it calls the yart TeX template without reliance of the R package yart. Just adopt the content of this boilerplate file to you need. See [this file](./yart-via-template.pdf) to check the PDF output. 



## Demo video



[![Demo video](https://raw.githubusercontent.com/sebastiansauer/yart/master/docs/video_thumbnail.png)](https://www.youtube.com/watch?v=pGnOlXur_D4&feature=youtu.be)



## Bugs, Feedback, Issues



Please report issues [here](https://github.com/sebastiansauer/yart/issues) along with a reproducible example if possible.



## Related work



A number of R packages for RMarkdown templates for PDF documents are available including



- [linl](https://github.com/cran/linl)

- [pinp](http://dirk.eddelbuettel.com/code/pinp.html)

- [rticles](https://github.com/rstudio/rticles)

- [tint](https://cran.r-project.org/web/packages/tint/index.html)



## Author



Sebastian Sauer



## License



GPL-3 for this package, the work in [pandoc-letter](https://github.com/aaronwolen/pandoc-letter),

as well as underlying Pandoc template.