editR
IMPORTANT: the latest version of editR (>=0.2) has undergone important
modifications (see release notes below). The most important changes are the
following:
- editR is now fully compatible with the latest version of shiny on
CRAN (>=0.11). editR was modified to support
Twitter Bootstrap version 3 instead of version 2 as
in the previous releases.
- editR now relies (almost) entirely on packages available through
CRAN and not on a large number of experimental
packages as previously. This will facilitate the installation process.
As a consequence of these modifications I strongly recommend that you reinstall
editR following the new instructions below.
editR is a basic Rmarkdown editor with instant
previewing of your document. It allows you to create and edit
Rmarkdown documents while instantly previewing the
result of your writing and coding. It also allows you to render your
Rmarkdown file in any format permitted by the
rmarkdown R package.
Installation
Installing editR from this GitHub repository is now pretty straightforward.
Simply copying the following lines of code in your R terminal should to install
everything you need to run editR on your computer:
if (!require("devtools")) install.packages("devtools")
devtools::install_github("trestletech/shinyAce")
devtools::install_github("swarm-lab/editR")
library(editR)
editR requires the installation of the latest versions of following packages
on CRAN:
It also requires the installation of the development version of the following package on GitHub:
Finally, to render documents in various output formats (.html, .pdf, .docx),
editR uses the render
function from the rmarkdown
package. This function requires the installation of pandoc
to work. Installation instructions for pandoc can be found at:
http://johnmacfarlane.net/pandoc/installing.html.
For Mac users, I recommend that you install pandoc via Homebrew or
MacPorts.
Usage
To start editR, simply run this line of code in your R console:
editR("path/to/file.Rmd")
with "path/to/file.Rmd" the path to a new or existing .Rmd (or .md) file. If this
is a new file, it will be created at this location. You can also open an existing
file from within editR using the File > Open file menu.
You can also open editR without providing a path to a new or existing .Rmd file.
editR()
In this case a temporary new file will be created that can then be saved from
withing the user interface of editR.
For more information about authoring Rmarkdown files, visit http://rmarkdown.rstudio.com/.
Maintainer(s)
Simon Garnier - @sjmgarnier - [email protected]
References
editR was built with shiny by @rstudio,
and its extensions
shinyBS by @ebailey78,
shinyFiles by @thomaso85 and
shinyAce by @trestletech