README.md

Overview

The rticles package includes a set of R Markdown templates that enable authoring of R related journal and conference submissions, and creating e-books. Available templates include:

• [Tuftish e-book] e-books formatted based on the style of Edward R. Tufte and Richard Feynman

• JSS articles

• R Journal articles

• useR conference abstracts

• Public Library of Science (PLoS) articles

• CTeX documents

• ACS articles

Under the hood, LaTeX templates are used to ensure that documents conform precisely to submission standards. At the same time, composition and formatting can be done using lightweight markdown syntax, and R code and its output can be seamlessly included using knitr.

Using rticles has some prerequisites which are described below. You can get most of these pre-requisites automatically by installing the latest preview release of RStudio (instructions for using rticles without RStudio are also provided).

Using rticles from RStudio

To use rticles from RStudio:

1. Install the latest RStudio.

2. Install the rticles package:

devtools::install_github("rstudio/rticles")

3. Use the New R Markdown dialog to create an article from one of the templates:

Using rticles outside of RStudio

1. Install pandoc using the instructions for your platform.

2. Install the rmarkdown and rticles packages:

devtools::install_github(c("rstudio/rmarkdown", "rstudio/rticles"))

3. Use the rmarkdown::draft function to create articles:

rmarkdown::draft("MyAbstract.Rmd", template = "use_r_abstract", package = "rticles")
rmarkdown::draft("MyJSSArticle.Rmd", template = "jss_article", package = "rticles")
rmarkdown::draft("MyRJournalArticle", template = "rjournal_article", package = "rticles")