571

rticles

Article Formats for R Markdown

A suite of custom R Markdown formats and templates for authoring journal articles and conference submissions.

Travis-CI Build Status Downloads from the RStudio CRAN mirror

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:

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

  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 rticles packages.

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

News

rticles 0.7

  • Added the template for the Frontiers Journals (@muschellij2, @zkamvar, #209).

  • Added the template for the AGU Journals (thanks, @eliocamp, #199).

  • Updated the template for PLOS to version 3.5 (thanks, @uvesten, #196).

  • No longer hardcode the LaTeX engine to xelatex in rsos_article() (thanks, @bensprung, #198).

  • Added an argument pandoc_args to ieee_article() so that users can pass custom Pandoc arguments. This also makes it work with bookdown::pdf_book() (thanks, @espinielli, #206).

  • The base_format argument has been removed from peerj_article() (#127) and copernicus_article() (#172). This argument was originally added mainly for supporting bookdown::pdf_book(), but you should really pass these formats to the base_format argument of bookdown::pdf_book instead of the other way around.

  • For output formats acm_article(), acs_article(), ams_article(), mnras_article(), the csl file should be specified as a top-level option in the YAML header of the document (this has been done in the R Markdown templates). It is no longer specified automatically by the output format functions.

  • The function ctex_template() was removed. If you need to use a custom LaTeX template for the ctex output format, just use the template option under ctex.

rticles 0.6

  • Added the template for the SAGE Journals (thanks, @oguzhanogreden, #181).

  • Added the template for Biometrics (thanks, @daltonhance, #170).

  • Added the template for Copernicus Publications journals (thanks, @nuest, #172).

  • Supports syntax highlighting in the ieee_article() and acm_article() formats (thanks, @rainer-rq-koelle, #182).

  • Disabled syntax highlighting for rjournal_article() (thanks, @eddelbuettel, #185).

rticles 0.5

  • Added the template for the IEEE Transaction Journals (thanks, @Emaasit, #97).

  • Added the PeerJ format (thanks, @zkamvar, #127).

  • Added a template for the Royal Society Open Science Journal (thanks, @ThierryO, #135).

  • Added a template for Bulletin de l'AMQ (thanks, @desautm, #145).

  • Added the MDPI journal template (thanks, @dleutnant, #147).

  • Added the Springer Journal Article template (thanks, @strakaps, #164).

  • Added the template for MNRAS (Monthly Notices of the Royal Astronomical Society) articles (thanks, @oleskiewicz, #175).

  • Fixed #6, #10, #49, #132, and #149: dollar signs and other special LaTeX characters such as ^ can be used in code chunks in JSS and R Journal articles now, but Pandoc 2.x will be required (you can use the Preview version of RStudio if you do not want to install Pandoc separately).

  • Fixed #9: special characters such as spaces and underscores can be used in Rmd filenames for R Journal articles now.

  • Fixed #71: bibliography is supported for The R Journal articles now.

  • Supports breaking the JSS author list into multiple lines; see #100 for details.

rticles 0.4.1

  • Add Royal Society Open Science journal template

rticles 0.2.0.9000

  • Add Institute of Electrical and Electronics Engineers (IEEE) IEEEtrans template for Conferences

rticles 0.2

  • Add American Chemical Society (ACS) template

  • Allow changing of documentclass and classoption for JSS articles

  • Support bibliography for JSS articles (#63)

  • Add tightlist macro to Elsevier skeleton

  • Add address and footnote examples to Elsevier skeleton

  • Fix preamble variable name in R Journal template

rticles 0.1

  • Initial release to CRAN

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.
install.packages("rticles")

0.14 by Yihui Xie, 4 months ago

https://github.com/rstudio/rticles

Report a bug at https://github.com/rstudio/rticles/issues

Browse source code at https://github.com/cran/rticles

Authors: JJ Allaire [aut] , Yihui Xie [aut, cre] , R Foundation [aut, cph] , Hadley Wickham [aut] , Journal of Statistical Software [aut, cph] , RStudio [cph] , Ramnath Vaidyanathan [aut, cph] , Association for Computing Machinery [aut, cph] , Carl Boettiger [aut, cph] , Elsevier [aut, cph] , Karl Broman [aut, cph] , Kirill Mueller [aut, cph] , Bastiaan Quast [aut, cph] , Randall Pruim [aut, cph] , Ben Marwick [aut, cph] , Charlotte Wickham [aut, cph] , Oliver Keyes [aut, cph] , Miao Yu [aut, cph] , Daniel Emaasit [aut, cph] , Thierry Onkelinx [aut, cph] , Alessandro Gasparini [aut, cph] , Marc-Andre Desautels [aut, cph] , Dominik Leutnant [aut, cph] , MDPI [aut, cph] , Taylor and Francis [aut, cph] , Oğuzhan Öğreden [aut] , Dalton Hance [aut] , Daniel Nüst [aut, cph] , Petter Uvesten [aut, cph] , Elio Campitelli [aut, cph] , John Muschelli [aut, cph] , Zhian N. Kamvar [aut, cph] , Noam Ross [aut, cph] , Robrecht Cannoodt [aut, cph] , rcannood) , Duncan Luguern [aut] , David M. Kaplan [aut, ctb] , dmkaplan2000)

Documentation:   PDF Manual  

GPL-3 license

Imports utils, rmarkdown, knitr, yaml, tinytex, xfun

Suggests testit, bookdown, xtable

System requirements: GNU make

Imported by rmd.

Suggested by UncertainInterval, VARshrink, forecast, markovchain, multgee, pkgdown, simmer, wrswoR.

See at CRAN

R links

R homepage

Download R

Mailing lists

R documentation

R manuals

R FAQs

The R Journal

CRAN links

CRAN homepage

CRAN repository policy

Submit a package

METACRAN stuff

About METACRAN

At github

Report a bug