1 2 3 4 5 6
Optionally, a character string specifying a file name in the working directory (or file path) to open in rite.
A logical specifying whether output and event handling (errors, warnings, messages, interrupts) should be sent to the rite output viewer panel rather than the R console. Default is
The environment in which the script should be evaluated, e.g.,
The font family used in rite. Default is “
The font size used in rite. Default is
A logical, specifying whether insertion (from opening a script, appending a script, or pasting a script) should be done “fast” (i.e., without running syntax highlighting. This can significantly improve load times but has the consequence of leaving added text unhighlighted unless modified. Default is
A character vector containing one or more of “r”, “latex”, “markdown”, “xml”, “roxygen”, “brew”, and “rest” to indicate what should be higlighted in script. Default is “r”. Note that using more than a few of these simultaneously may cause unexpected highlighting.
A logical specifying whether the script should automatically be saved whenever any of the script is run. Default is
Whether the R calls should be copied to output during
A character string indicating what text should be inserted when the
A character string indicating what text should be used for commenting. Default is the hash/pound character.
Create, edit, and save R scripts (or any text-based file) and, optionally, sink output to an output viewer rather than the R console.
Scripts can be loaded, appended, referenced (via
source) in the current script, and can be saved. As of rite version 0.3, scripts can also be saved to and loaded from anonymous GitHub gists to facilitate code sharing.
Scripts can be run by selection, line, or the entire contents of the script editor from the “Run” menu. Scripts can also be run from the context menu (via a right mouse click) or with
<Control-Return> to run a selection or the current line.
<F8> runs the entire script, whereas
<F7> checks for parsing errors in the entire script without evaluating it (all code is parsed before running, automatically).
Command completion is now fully supported by pressing
<F2> (a right mouse button click on the menu will close it if no selection is desired). If a function is complete and followed by an open parenetheses (e.g.,
data.frame(, the command completion keys bring up a selectable list named arguments for the function. If a dataframe or environment name is complete and followed by a dollar sign (e.g.,
mydf$), the command completion keys bring up a list of named elements in the dataframe or environment.
<F2> also opens code chunk arguments after code chunk openings, argument formals after function names, and working directory files and directories after open quotes.
riteout is a wrapper for
rite that defaults to
catchOutput=TRUE, which provides access to various report generation tools, described in detail below.
Functions and other objects from loaded packages are highlighted by default on-the-fly.
By default, the following colors are used for syntax highlighting:
Normal text (normal): “black”
Editor background (background): “white”
R functions (functions): “purple” (this applies to both base functions and those from packages loaded within
R comments (rcomments): “darkgreen”
Operators (operators): “blue”
Brackets (brackets): “darkblue”
Digits (digits): “orange”
Character strings (characters): “darkgray”
LaTeX macros (latexmacros): “darkred”
LaTeX equations (latexequations): “black”
LaTeX comments (latexcomments): “red”
Sweave/knitr code chunks (rnwchunks): “blue”
Rtex code chunks (rtexchunks): “blue”
Markdown (rmd): “darkred”
Markdown code chunks (rmdchunks): “blue”
XML/HTML tags (xml): “darkred”
XML/HTML comments (xmlcomments): “red”
Roxygen text (roxygentext): “black”
Roxygen code chunks (roxygenchunks): “blue”
Brew comments (brewcomments): “red”
Brew chunks (brewchunks): “blue”
Brew templates (brewtemplate): “black”
reST chunks (restchunks): “blue”
The use of highlighting in general can be regulated by the
highlight parameter. To specify alternative specific colors for any of the above highlighting rules, the
color parameter accepts a named list of content types (listed in parentheses above) and their corresponding colors (in quotes). For example, calling
rite(color=list(rcomments='pink')), would open
rite with R comments highlighted in pink but leave all other highlighting rules at their default settings.
<Ctrl-o>: Open script
<Ctrl-s>: Save script as
<Ctrl-r>: Run/evaluate line (or selection, if applicable)
<Control-Return>: Run/evaluate line (or selection, if applicable)
<Ctrl-a>: Select all
<Ctrl-e>: Move cursor to end of current line
<Shift-e>: Adjust selection to end of current line
<Ctrl-g>: Go to line
<Tab>: Indent line
<Ctrl-i>: Indent line(s)
<Ctrl-u>: Unindent line
<Ctrl-k>: Toggle comment on/off for line(s)
<Ctrl-l>: Clear output panel
<Shift> and <Left>, <Right>, or drag left mouse: Adjust selection by character
<Control-Shift-Left> or <Control-Shift-Right>: Adjust selection by word
<Control-Up> or <Control-Down>: Move insertion cursor by paragraphs
<Control-Shift-Up> or <Control-Shift-Down>: Adjust selection by paragraph
<F1>: Open help for current function, if a known function (based on cursor position); or the results of help.search()
<F2>: Open command completion context menu (based on cursor position). A right-button mouse click closes the context menu if no selection is desired (not necessary on all platforms).
<F7>: Try to parse the script and return any syntax errors (does not evaluate the script)
<F8>: Run/evaluate all code
Left mouse click (1 time): Move cursor
Left mouse click (2 times): Select word
Left mouse click (3 times): Select line
Right mouse click (1 time): Open context menu
catchOutput=TRUE (or rite is loaded with
rite provides a number of report generation capabilities provided by
knitr. Specifically, a “Report Generation” menu becomes available that includes the following options. By default, the available tools generate reports from the currently open script in rite, but all the tools can also be run on local files (which opens those files into rite). The general pattern of report generation behavior is to load the input file, display the output file in the
riteout output tab, display any relevant processing information in the
riteout message tab, and open the resulting output file (in the case of functions that produce PDFs or HTML files). The resulting output files can be saved using “Save Output” from the “Output” menu.
The following tools are available:
knit on the contents of the script panel and returns them in the output panel. Optionally, an R markdown (Rmd) file can be converted directly to HTML and opened. And, optionally, an Rnw file (for knitr or Sweave) can be converted directly to PDF and opened. Support for converting Sweave documents to knitr format can prevent compatibility issues between the two formats.
purl on the contents of the script panel and returns them in the output panel. This is the knitr equivalent of Stangle, producing code-only output from the original document. Again, optionally, an Rnw file (for knitr or Sweave) can be converted directly to PDF and opened. Support for converting Sweave documents to knitr format can prevent compatibility issues between the two formats.
stitch on the contents of the script panel, embedding it into an LaTeX file (and opens the resulting PDF), markdown file (and opens the resulting HTML), or HTML file (and opens the resulting HTML), based on a simple template. This is helpful for converting an unformatted R script into a simple report.
spin on the contents of the script panel, which should be a specially formatted roxygen-style script. The output is a knitr file, which can optionally be
knit or simply displayed into the output tab.
markdown: Convert an R markdown document to either a full HTML document or an HTML fragment (without
body tags) to embed, e.g., in a blog post.
XeLaTeX: Run LaTeX or XeLaTeX and, optionally, BibTex as a system call. knitr compiles LaTeX to PDF via DVI using the functionality supplied by the
tools package, so these report generation tools provide functionality for .tex scripts that are not compatible with DVI.
Thomas J. Leeper
1 2 3 4 5 6 7 8 9 10 11
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.