bhanditz / rticles

:exclamation: This is a read-only mirror of the CRAN R package repository. rticles — Article Formats for R Markdown. Homepage: https://github.com/rstudio/rticles Report bugs for this package: https://github.com/rstudio/rticles/issues

Installation

You can install and use rticles from CRAN as follows:

install.packages("rticles")

If you wish to install the development version from GitHub (which often contains new article formats), you can do this:

devtools::install_github("rstudio/rticles")

Overview

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

• ACM articles

• ACS articles

• AEA journal submissions

• AMS articles

• Biometrics articles

• Bulletin de l'AMQ journal submissions

• CTeX documents

• Elsevier journal submissions

• IEEE Transaction journal submissions

• JSS articles

• MDPI journal submissions

• Monthly Notices of the Royal Astronomical Society articles

• NNRAS journal submissions

• PeerJ articles

• Royal Society Open Science journal submissions

• Sage journal submissions

• Springer journal submissions

• Statistics in Medicine journal submissions

• Copernicus Publications journal submissions

• The R Journal 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 requires the prerequisites described below. You can get most of these 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")

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")