Skip to content

Latest commit

 

History

History
97 lines (55 loc) · 3.56 KB

README.md

File metadata and controls

97 lines (55 loc) · 3.56 KB

Travis-CI Build Status

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:

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:

    New R Markdown

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