Improving the track changes and reviewing experience in R markdown. reviewer provides two main functions:

  • an RStudio addin that adds the required JavaScript code to an rmarkdown document, so that when rendered to HTML it can be annotated using the Hypothes.is service
  • the capability to compare two versions of an rmarkdown document and display their differences in a nicely-formatted manner.

Installation

You can install the development version of reviewer from GitHub with:

remotes::install_github("ropenscilabs/reviewer")

Annotating web pages

Important note

In order to use the annotation functionality it is needed to sign-up at the Hypothes.is website


Differences between rmarkdown files

The diff_rmd function can be used to produce a nicely-formatted document showing the differences between two rmarkdown files. This function can be used to compare two files, or a file with previous versions of itself (within a git repository).

See the package vignette for a demonstration.