• Stars
    star
    1,402
  • Rank 31,642 (Top 0.7 %)
  • Language
    TeX
  • Created almost 10 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

LaTeX Journal Article Templates for R Markdown

R-CMD-check Downloads from the RStudio CRAN mirror CRAN status Codecov test coverage

rticles

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

R Markdown: The Definitive Guide

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:

New R Markdown

New R Markdown

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 @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 @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 rss_article()
Sage @oguzhanogreden #181 sage_article()
Springer @strakaps #164 springer_article()
Springer Lecture Notes in Computer Science (LCNS) @eliocamp #445 lncs_article()
SIM: Statistics in Medicine https://onlinelibrary.wiley.com/journal/10970258) @ellessenne #231 sim_article()
Taylor & Francis @dleutnant #218 tf_article()
The R Journal rjournal_article()
TRB @gregmacfarlane #427 trb_article()
Wellcome Open Research @arnold-c #436 wellcomeor_article()

You can also get the list of available journal names with rticles::journals().

rticles::journals()
#>  [1] "acm"            "acs"            "aea"            "agu"           
#>  [5] "ajs"            "amq"            "ams"            "arxiv"         
#>  [9] "asa"            "bioinformatics" "biometrics"     "copernicus"    
#> [13] "ctex"           "elsevier"       "frontiers"      "glossa"        
#> [17] "ieee"           "ims"            "informs"        "iop"           
#> [21] "isba"           "jasa"           "jedm"           "joss"          
#> [25] "jss"            "lipics"         "lncs"           "mdpi"          
#> [29] "mnras"          "oup_v0"         "oup_v1"         "peerj"         
#> [33] "pihph"          "plos"           "pnas"           "rjournal"      
#> [37] "rsos"           "rss"            "sage"           "sim"           
#> [41] "springer"       "tf"             "trb"            "wellcomeor"

Those are the values to use within rmarkdown::draft().

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.

Getting help

There are two main places to get help:

  1. The RStudio community is a friendly place to ask any questions about rticles. Be sure to use the rticles tag.

  2. Stack Overflow is a great source of answers to common bookdown questions. Use the tags [r][rticles] if you ask a question.

Code of Conduct

Please note that the rticles project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

How to contribute?

Most of the templates are contributed directly by the users in the community. If you want rticles to offer a new journal format, you can contribute by the following way.

Suggest an idea for new format opening an issue.

You may not feel confident enough or may not have time to contribute a new format. By opening a new issue, you can share the idea for this format, and see if someone in the community can help on it.
This is not the best way to quickly get your format included but at least it is a great way to see if others are interested too.

To see the existing suggested formats, just filter issues with the help wanted ❤️ label. You can then add a 👍 or help to add the template 😉.

Contribute a new template format opening a pull request.

To contribute a new format, you need to open a new pull request (PR). When opening the PR, you’ll see the PR template explaining how to proceed and what is important to check. Please follow it.
Even if you are just starting or you are not finished, you share your work by creating a draft PR. It is a great way to let us know that you are still working on it (like these opened ones), and it is also a great way to ask for help from the community.
When you are ready, you can submit the PR for review, and we will iterate until it is merged.

Technical resources helpful to contribute a template

The best way to get started is to look at the previous examples of submitted PR. You’ll find links to them in the table above.

All the rticles format are build similarly by providing a new pandoc tex template to replace the default one. You’ll learn more about pandoc templates in these places:

You can study existing formats to see how all this works.

More Repositories

1

cheatsheets

Posit Cheat Sheets - Can also be found at https://posit.co/resources/cheatsheets/.
TeX
5,382
star
2

shiny

Easy interactive web applications with R
R
5,139
star
3

rstudio

RStudio is an integrated development environment (IDE) for R
Java
4,432
star
4

bookdown

Authoring Books and Technical Documents with R Markdown
JavaScript
3,525
star
5

rmarkdown

Dynamic Documents for R
R
2,737
star
6

shiny-examples

JavaScript
1,909
star
7

gt

Easily generate information-rich, publication-quality tables from R
R
1,853
star
8

blogdown

Create Blogs and Websites with R Markdown
R
1,691
star
9

reticulate

R Interface to Python
R
1,604
star
10

webinars

Code and slides for RStudio webinars
HTML
1,510
star
11

plumber

Turn your R code into a web API.
R
1,352
star
12

tensorflow

TensorFlow for R
R
1,313
star
13

renv

renv: Project environments for R.
R
949
star
14

shinydashboard

Shiny Dashboarding framework
CSS
852
star
15

pagedown

Paginate the HTML Output of R Markdown with CSS for Print
R
850
star
16

keras

R Interface to Keras
R
811
star
17

pointblank

Data quality assessment and metadata reporting for data frames and database tables
R
794
star
18

flexdashboard

Easy interactive dashboards for R
JavaScript
778
star
19

leaflet

R Interface to Leaflet Maps
JavaScript
775
star
20

rmarkdown-book

R Markdown: The Definitive Guide (published by Chapman & Hall/CRC in July 2018)
RMarkdown
738
star
21

ggvis

Interactive grammar of graphics for R
R
709
star
22

rstudio-conf

Materials for rstudio::conf
HTML
694
star
23

learnr

Interactive Tutorials with R Markdown
R
692
star
24

shiny-server

Host Shiny applications over the web.
JavaScript
686
star
25

RStartHere

A guide to some of the most useful R Packages that we know about
R
655
star
26

py-shiny

Shiny for Python
Python
627
star
27

DT

R Interface to the jQuery Plug-in DataTables
JavaScript
577
star
28

rmarkdown-cookbook

R Markdown Cookbook. A range of tips and tricks to make better use of R Markdown.
RMarkdown
562
star
29

blastula

Easily send great-looking HTML email messages from R
R
522
star
30

r2d3

R Interface to D3 Visualizations
R
506
star
31

bookdown-demo

A minimal book example using bookdown
CSS
476
star
32

hex-stickers

RStudio hex stickers
R
426
star
33

distill

Distill for R Markdown
HTML
418
star
34

bslib

Tools for theming Shiny and R Markdown via Bootstrap 3, 4, or 5.
SCSS
408
star
35

packrat

Packrat is a dependency management system for R
R
394
star
36

tufte

Tufte Styles for R Markdown Documents
R
385
star
37

dygraphs

R interface to dygraphs
JavaScript
358
star
38

revealjs

R Markdown Format for reveal.js Presentations
JavaScript
316
star
39

pins-r

Pin, Discover and Share Resources
R
295
star
40

fontawesome

Easily insert FontAwesome icons into R Markdown docs and Shiny apps
R
288
star
41

profvis

Visualize R profiling data
JavaScript
285
star
42

crosstalk

Inter-htmlwidget communication for R (with and without Shiny)
JavaScript
283
star
43

config

config package for R
R
248
star
44

pool

Object Pooling in R
R
241
star
45

thematic

Theme ggplot2, lattice, and base graphics based on a few simple settings.
R
237
star
46

Intro

Course materials for "Introduction to Data Science with R", a video course by RStudio and O'Reilly Media
R
234
star
47

shinytest

Automated testing for shiny apps
JavaScript
227
star
48

tinytex-releases

Windows/macOS/Linux binaries and installation methods of TinyTeX
PowerShell
226
star
49

httpuv

HTTP and WebSocket server package for R
C
217
star
50

nomnoml

Sassy 'UML' Diagrams for R
JavaScript
216
star
51

shinymeta

Record and expose Shiny app logic using metaprogramming
R
212
star
52

htmltools

Tools for HTML generation and output
R
201
star
53

shinyuieditor

A GUI for laying out a Shiny application that generates clean and human-readable UI code
JavaScript
198
star
54

promises

A promise library for R
R
191
star
55

vetiver-r

Version, share, deploy, and monitor models
R
170
star
56

rstudioapi

Safely access RStudio's API (when available)
R
161
star
57

gradethis

Tools for teachers to use with learnr
R
161
star
58

concept-maps

Concept maps for all things data science
HTML
158
star
59

master-the-tidyverse

Course contents for Master the Tidyverse
158
star
60

shinythemes

Themes for Shiny
R
152
star
61

ShinyDeveloperConference

Materials collected from the First Shiny Developer Conference Palo Alto, CA January 30-31 2016
HTML
151
star
62

chromote

Chrome Remote Interface for R
R
143
star
63

shiny-gallery

Code and other documentation for apps in the Shiny Gallery ✨
HTML
139
star
64

sortable

R htmlwidget for Sortable.js
R
124
star
65

rsconnect

Publish Shiny Applications, RMarkdown Documents, Jupyter Notebooks, Plumber APIs, and more
R
120
star
66

reactlog

Shiny Reactivity Visualizer
JavaScript
119
star
67

redx

dynamic nginx configuration
Lua
118
star
68

bigdataclass

Two-day workshop that covers how to use R to interact databases and Spark
R
113
star
69

shinyapps

Deploy Shiny applications to ShinyApps
110
star
70

shinyloadtest

Tools for load testing Shiny applications
HTML
109
star
71

webshot2

Take screenshots of web pages from R
R
108
star
72

shinyvalidate

Input validation package for the Shiny web framework
JavaScript
108
star
73

r-docker

Docker images for R
Dockerfile
105
star
74

miniUI

R
102
star
75

sass

Sass compiler package for R
C++
102
star
76

r-system-requirements

System requirements for R packages
Shell
100
star
77

shinytest2

R
96
star
78

keras-customer-churn

Customer Churn Shiny Application
R
96
star
79

r-builds

an opinionated environment for compiling R
Shell
91
star
80

addinexamples

An R package showcasing how RStudio addins can be registered and used.
R
85
star
81

r-manuals

A re-styled version of the R manuals
R
83
star
82

shinyapps-package-dependencies

Collection of bash scripts that install R package system dependencies
R
74
star
83

markdown

The first generation of Markdown rendering for R (born in 2012). Originally based on the C library sundown. Now based on commonmark. Note that this package is markdown, not *rmarkdown*.
R
72
star
84

R-Websockets

HTML 5 Websockets implementation for R
R
68
star
85

webdriver

WebDriver client in R
R
68
star
86

beyond-dashboard-fatigue

Materials for the RStudio webinar 'Beyond Dashboard Fatigue'
R
66
star
87

cloudml

R interface to Google Cloud Machine Learning Engine
R
65
star
88

shinylive

Run Shiny on Python (compiled to wasm) in the browser
TypeScript
61
star
89

rstudio-conf-2022-program

rstudio::conf(2022, "program")
R
61
star
90

rstudio-docker-products

Docker images for RStudio Professional Products
Just
59
star
91

bookdown.org

Source documents to generate the bookdown.org website
R
59
star
92

education.rstudio.com

CSS
57
star
93

tfestimators

R interface to TensorFlow Estimators
R
57
star
94

sparkDemos

HTML
54
star
95

vetiver-python

Version, share, deploy, and monitor models.
Python
54
star
96

tfprobability

R interface to TensorFlow Probability
R
54
star
97

shiny-incubator

Examples and ideas that don't belong in the core Shiny package and aren't officially supported.
JavaScript
53
star
98

connections

https://rstudio.github.io/connections/
R
52
star
99

swagger

Swagger is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
HTML
51
star
100

leaflet.mapboxgl

Extends the R Leaflet package with a Mapbox GL JS plugin to allow easy drawing of vector tile layers.
R
49
star