The goal of rjtools is to make it easier for AUTHORS of R Journal articles to
- create a new paper from a template that will produce both html and pdf versions in the format needed by the journal, and
- 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(name = "quokka-bilby")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/issues/2021-1/. Particularly articles by Wang, and two articles by Kane, and the editorial.
To learn more on the article creation, read Create an R Journal Article.
For more information on the R Journal format, specifically how to create figures, tables, among others with the new format, read More details on the R Journal format.
The rendered template article is showcased in The Article Template.
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.
- See Check your Article Before Submission for more on this.
