|Noam Ross 3393313fe2 Update redoc() documentation||1 year ago|
|.github||1 year ago|
|R||1 year ago|
|inst||1 year ago|
|man||1 year ago|
|pkgdown||1 year ago|
|tests||1 year ago|
|vignettes||1 year ago|
|.Rbuildignore||1 year ago|
|.gitignore||1 year ago|
|.travis.yml||1 year ago|
|DESCRIPTION||1 year ago|
|LICENSE||1 year ago|
|NAMESPACE||1 year ago|
|NEWS.md||1 year ago|
|README.Rmd||1 year ago|
|README.md||1 year ago|
|appveyor.yml||1 year ago|
|codecov.yml||1 year ago|
|redoc.Rproj||1 year ago|
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
highlight_outputs = FALSE)
.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:
redoc_diff()in the RStudio viewer.
The package also contains a
dedoc R Markdown template.
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.