https://github.com/ropensci-archive/reviewer

:no_entry: ARCHIVED :no_entry: Improving the Track Changes and Reviewing Experience in R Markdown
https://github.com/ropensci-archive/reviewer

ozunconf18 r r-package rstats unconf

Last synced: 3 months ago
JSON representation

:no_entry: ARCHIVED :no_entry: Improving the Track Changes and Reviewing Experience in R Markdown

• Host: GitHub
• URL: https://github.com/ropensci-archive/reviewer
• Owner: ropensci-archive
• License: other
• Archived: true
• Created: 2018-11-22T00:20:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-05-10T14:12:18.000Z (over 2 years ago)
• Last Synced: 2024-06-11T18:19:56.678Z (5 months ago)
• Topics: ozunconf18, r, r-package, rstats, unconf
• Language: R
• Homepage:
• Size: 519 KB
• Stars: 43
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README-NOT.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - ropensci-archive/reviewer - :no_entry: ARCHIVED :no_entry: Improving the Track Changes and Reviewing Experience in R Markdown (R)

README

        


# reviewer

[![Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.](https://www.repostatus.org/badges/latest/abandoned.svg)](https://www.repostatus.org/#abandoned)

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.

## Annotating web pages

### Important note

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

[the Hypothes.is website](https://hypothes.is/signup)

-----

## 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](https://ropenscilabs.github.io/reviewer/articles/reviewer.html)

for a demonstration.

## Related packages

  - [trackmd](https://github.com/ropenscilabs/trackmd) is similar to

    `reviewer`, but:

    

      - is an RStudio-specific addin, whereas `reviewer` can be used

        outside of the RStudio environment (e.g. with your preferred

        text editor)

      - shows changes only in the *rendered* rmarkdown file (i.e. once

        it has been converted to its HTML document format). `reviewer`

        can show changes in either the raw rmarkdown document or its

        rendered output.

  - [latexdiffr](https://github.com/hughjonesd/latexdiffr) similarly

    shows differences in the *rendered* document, but uses the

    `latexdiff` utility to do so (you need `latexdiff` installed on your

    system to use it). It can also be used outside of RStudio.

  - [diffobj](https://github.com/brodieG/diffobj) provides a colourized

    depiction of the differences between arbitrary R objects. This could

    be used to compare two rmarkdown documents by e.g. reading their

    contents into character vectors and applying the `diffChr` function.

  - [rmdrive](https://github.com/ekothe/rmdrive) allows easy

    round-tripping of an rmarkdown document to Google Drive, where it

    can be edited by non-R-using collaborators, and back again. The

    edited changes could then be viewed using `reviewer`.

  - [markdrive](https://github.com/MilesMcBain/markdrive) is similar to

    `rmdrive`, but pushes the *rendered* rmarkdown document to and from

    Google.