<!-- README.md is generated from README.Rmd. Please edit that file --> <!-- badges: start -->

<!-- badges: end -->

rticles <a href="https://pkgs.rstudio.com/rticles/"><img src="man/figures/logo.png" align="right" height="138"/></a>

The rticles package provides a suite of custom R Markdown LaTeX formats and templates for various formats. Most of the templates are provided and maintained by the community, and anyone can contribute a new template. See How to contribute below.

Book

<a href="https://bookdown.org/yihui/rmarkdown/journals.html"><img src="https://bookdown.org/yihui/rmarkdown/images/cover.png" alt="R Markdown: The Definitive Guide" class="book" height="400"/></a>

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:

# install.packages("pak")
pak::pak("rstudio/rticles")

Using rticles

To use rticles from RStudio, you can access the templates through File -> New File -> R Markdown. This will open the dialog box where you can select from one of the available templates:

<figure> <img src="https://bookdown.org/yihui/rmarkdown/images/rticles-templates.png" alt="New R Markdown" /> <figcaption aria-hidden="true">New R Markdown</figcaption> </figure>

If you are not using RStudio, you’ll also need to install Pandoc following these instructions. Then, use the rmarkdown::draft() function to create articles:

rmarkdown::draft(
    "MyJSSArticle.Rmd", template = "jss", package = "rticles"
)
rmarkdown::draft(
    "MyRJournalArticle", template = "rjournal", package = "rticles"
)

This will create a folder containing a Rmd file using the corresponding output format and all the assets required by this format.

Templates

Currently included templates and their contributors are the following:

| Journal | Contributors | Pull request | Output format | |----|----|----|----| | ACM: Association for Computings Machinery | @ramnathv | #8 | acm_article() | | ACS https://pubs.acs.org | @yufree | #15 | acs_article() | | AEA: American Economic Association | @sboysel | #86 | aea_articles() | | AGU https://agupubs.onlinelibrary.wiley.com/ | @eliocamp | #199 | agu_article() | | AJS: Austrian Journal of Statistics | @matthias-da | #437 | ajs_article() | | AMS: American Meteorological Society | @yufree | #96 | ams_article() | | ASA: American Statistical Association https://www.amstat.org/ | | #111 | asa_article() | | arXiv pre-prints based on George Kour’s template | @alexpghayes | #236 | arxiv_article() | | Bioinformatics | @ShixiangWang | #297 | bioinformatics_article() | | Biometrics | @daltonhance | #170 | biometrics_article() | | Bulletin de l’AMQ (https://www.amq.math.ca/bulletin/) | @desautm | #145 | amq_article() | | Copernicus Publications | @nuest, @RLumSK | #172, #342 | copernicus_article() | | CTeX | | | ctex() | | Elsevier | @cboettig, @robjhyndman | #27, #467 | elsevier_article() | | Frontiers | @muschellij2 | #211 | frontiers_article() | | Glossa | @stefanocoretta | #361 | glossa_article() | | IEEE Transaction | @Emaasit, @espinielli, @nathanweeks, @DunLug | #97, #169, #227, #263, #264, #265 | ieee_article() | | IMS: Institute of Mathematical Statistics AoAS: Annals of Applied Statistics | @auzaheta | #372 | ims_article() | | INFORMS: Institute for Operations Research and the Management Sciences | @robjhyndman | #460 | informs_article() | | ISBA: International Society for Bayesian Analysis | @dmi3nko | #461 | isba_article() | | IOP: Institute of Physics (https://iopscience.iop.org) | @robjhyndman | #462 | iop_article() | | JASA: Journal of the Acoustical Society of America | @stefanocoretta | #364 | jasa_article() | | Journal of Educational Data Mining journal submissions | @jooyoungseo | #251 | jedm_article() | | JOSS: Journal of Open Source Software JOSE: Journal of Open Source Education | @noamross | #229 | joss_article() | | JSS: Journal of Statistical Software | | | jss_article() | | LIPIcs | @nuest | #288 | lipics_article() | | MDPI | @dleutnant, @mps9506 | #147, #515 | mdpi_article() | | MNRAS: Monthly Notices of the Royal Astronomical Society | @oleskiewicz | #175 | mnras_article() | | OUP: Oxford University Press | @dmkaplan | #284 | oup_articles() | | PeerJ: Journal of Life and Environmental Sciences | @zkamvar | #127 | peerj_article() | | PiHPh: Papers in Historical Phonology | @stefanocoretta | #362 | pihph_article() | | PLOS | @sjmgarnier | #12 | plos_article() | | PNAS: Proceedings of the National Academy of Sciences (https://www.pnas.org/) | @cboettig | #72 | pnas_article() | | RSOS: Royal Society Open Science https://www.royalsocietypublishing.org/journal/rsos | @ThierryO | #135 | rsos_article() | | RSS: Royal Statistical Society | @carlganz | [#110](https://gi