The goal of rjtools is to make it easier for AUTHORS of R Journal articles to

  1. create a new paper from a template that will produce both html and pdf versions in the format needed by the journal, and
  2. to run various checks on their paper, that it satisfies various requirements, in preparation for submitting it to the journal.

Installation

You can install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("rjournal/rjtools")

Getting started with a new article

To create an article template under the project directory:

library(rjtools)
create_article(file_name = "my_article")

To examine how the papers in this format would look in an R Journal issue, take a look at the June 2021 issue https://journal.r-project.org/dev/issues/2021-1/. Particularly articles by Wang, and two articles by Kane, and the editorial.

Checking that your paper satisfies various conditions

Explore the various check_XXX functions that will check the format of your article, and some submission requirements.