Repository files navigation

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

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

You can install the development version fromGitHub with:

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

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 Journalissue, take a look at the June 2021 issuehttps://journal.r-project.org/issues/2021-1/. Particularly articles byWang, and two articles by Kane, and the editorial.

• To learn more on the article creation, readCreate an R JournalArticle.

• For more information on the R Journal format, specifically how tocreate figures, tables, among others with the new format, readMoredetails on the R Journalformat.

• The rendered template article is showcased inThe ArticleTemplate.

Explore the variouscheck_XXX functions that will check the format ofyour article, and some submission requirements.

• SeeCheck your Article BeforeSubmissionfor more on this.

Please render the article using these lines:

pandoc::pandoc_activate(version = '3.1.6')rmarkdown::render("quokka-bilby.Rmd", output_format = "all")

in your R Console. Also make sure the output in theyaml is set as:

output:   rjtools::rjournal_pdf_article:    toc: no  rjtools::rjournal_web_article:    self_contained: yes    toc: no