mikebirdgeneau / rticles

Installation

You can install and use rticles from CRAN as follows:

install.packages("rticles", type = "source")

If you wish to install the development version from GitHub you can do this:

devtools::install_github("rstudio/rticles")

Sandbox Version

Prior to submitting rticles to CRAN a number of formats that were not passing tests on all platforms were removed from the package (we expect that these formats will be restored eventually once their authors arrange for the tests to pass). If you are an existing user of one of these rticles formats you can install the "sandbox" version of the package which retains these formats as follows:

devtools::install_github("rstudio/rticles", ref = "sandbox")

Overview

The rticles package provides a suite of custom R Markdown LaTeX formats and templates for varoius formats, including:

• JSS articles

• R Journal articles

• CTeX documents

• ACM articles

• ACS articles

• Elsevier journal submissions

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 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:

   install.packages("rticles", type = "source")

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:

   install.packages("rmarkdown") devtools::install_github("rstudio/rticles")

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

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