Learn R Programming

⚠️There's a newer version (1.0.18) of this package.Take me there.

rjtools

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(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.

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.

Copy Link

Version

Install

install.packages('rjtools')

Monthly Downloads

229

Version

1.0.13

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Di Cook

Last Published

April 15th, 2024

Functions in rjtools (1.0.13)

keywords

Keywords options for R Journal
rjournal_pdf_issue

R Markdown output formats for R Journal issues
prep_submission

Prepare pre-filled fields in the submission form prep_submission generate some answers based on the .tex file to fill the article submission form. You can save the answers if assigned it to an object.
submit_rjournal

Submit a paper to the R Journal
rjournal_article

R Markdown output formats for R Journal articles
create_article

Create an R Journal article with the existing template
initial_check_article

A single article check
zip_paper

Zip your directory for R Journal submission
rjournal_website

R Markdown site generator for the R Journal
log_error

Logging functions
rjtools-package

rjtools: Preparing, Checking, and Submitting Articles to the 'R Journal'
symbol

Various handy symbols to use in a command line UI