View source: R/highlightCode.R
highlightCode | R Documentation |
This function leverages the highlight
package to create
an HTML display of R code.
It connects all instances of a variable in the code so that
a viewer can move the mouse over a variable and see all uses of it
in the code.
The motivations for this is to help navigate a script and to allow us to connect the code to plots of, for example, the time-line or life-span of variables in a script.
highlightCode(obj, out = NULL, addFunctionLinks = TRUE, checkURLs= TRUE,
inline = TRUE, h = htmlRenderer(addFunctionLinks,
checkURLs), css = system.file("CSS", "highlight.css",
package = "CodeDepends"), jsCode =
system.file("JavaScript", "highlightSymbols.js", package =
"CodeDepends"))
obj |
the name of a file containing R code or an R expression or function. Currently, this needs to be a file. |
out |
the name of a file to which the HTML document is written,
or |
addFunctionLinks |
how to generate the links for function
calls. This can be |
checkURLs |
When sorting through possible link targets, should we
check for existing local files OR URLs. Defaults to |
inline |
a logical value indicating whether to put the CSS and JavaScript code directly into the HTML document or just refer to them. |
h |
the renderer to create the HTML. See |
css |
the URL or local file name for the CSS content |
jsCode |
the URL or local file name for the JavaScript code for the highlighting of the variables. |
This uses the highlight
function
to create the basic information for the code. We provide
our own renderer to provide the links for function calls and
packages and to specify markup for the symbols.
Then we post-process the resulting HTML document to add our
own CSS content and JavaScript code.
An HTML document or the name of the file to which it was written if
out
is specified.
Duncan Temple Lang
f = system.file("samples", "sitepairs.R", package = "CodeDepends")
## url checking takes a while, too long for CRAN example
highlightCode(f, "foo.html", checkURLs=FALSE)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.