redoc - Reversible Reproducible Documents
redoc is a package to enable a two-way R Markdown-Microsoft Word workflow. It generates Word documents that can be de-rendered back into R Markdown, retaining edits on the Word document, including tracked changes.
redoc is not yet stable; its core engine and API are still subject to change. It’s been overhauled a few times already! I welcome your contributions and feedback.
Install the redoc package with the remotes (or devtools) package:
Note that redoc requires a recent version of Pandoc (>= 2.1.2). If you have RStudio version 1.2 or higher, you should have this by default.
redoc provides an R Markdown output
redoc(), built on top of
rmarkdown::word_document(). You will
typically call it via the YAML header in your R Markdown document. You
have the option of highlighting the outputs (both chunk and inline) in
the Word Document.
--- output: redoc::redoc ---
redoc() output resembles typical R Markdown Word output, but has some
- Critic Markup edits will be converted to Word tracked changes.
- By default, parts of the documented generated programmatically will
be highlighted. (Change this with
highlight_outputs = FALSE)
- The original
.Rmdand all code is stored internally in Word document for later retrieval.
Word files that have been created by
redoc() can be reverted to
dedoc() function, even after they are edited.
will return the path of the de-rendered document.
library(redoc) print(basename(redoc_example_docx())) #>  "example.docx" dedoc(redoc_example_docx()) #>  "./example.Rmd"
If the Word document has tracked changes,
dedoc() will, by default,
convert these to back to Critic Markup syntax. However, tracked changes
are not necessary. You can view the changes between the original R
Markdown file and the de-rendered one using the
redoc has three RStudio Addins to simplify workflow when working with R Markdown documents:
- “Render and Update” renders an R Markdown Document and the updates the text after round-tripping in to Word format and back. This helps with cleaning up small syntax differences (e.g. white space, line wrapping).
- “Dedoc to active file” and “Dedoc to new file” de-render a file and
place the contents in RStudio editor tabs, and also display a the
redoc_diff()in the RStudio viewer.
The package also contains a
dedoc R Markdown template.
- officedown produces rich MS Word documents from R Markdown. We hope for more integration between these packages in the future.
- diffobj visualizes differences between R objects and drives redoc’s diff view.
Want have feedback or want to contribute? Great! Please take a look at the contributing guidelines before filing an issue or pull request.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.