addToHTMLTemplate: Add D3 JavaScript content to an HTML document

In duncantl/RD3Device: R Graphics device to create D3 content

Description

This function facilitates inserting D3 (JavaScript) code into an HTML document. The JavaScript code is typically generated by d3Device and the R graphics engine. The function also allows us to add additional supporting JavaScript code and CSS content.

Usage

addToHTMLTemplate(code, outfile = character(),
                  supportCode = system.file("JavaScript", "Plot.js", package = "RD3Device"),
                  html = system.file("template", "template.html", package = "RD3Device"),
                  css = character(), div = "svg",
                  isFile = length(code) == 1 && file.exists(code))

Arguments

code	a character vector containing the JavaScript code or the name of a file containing the JavaScript code.
outfile	the name of the file to which the HTML document will be written. This is different from the template file.
supportCode	the names of one or more JavaScript files which should also be included in the HTML document. These are intended for supporting code that defines classes and functions used by the JavaScript D3 code to creat the display.
html	the name of the template HTML document which we fill in
css	the name of a CSS file or the actual contents of the CSS. If specified, the contents are inserted into the head of the HTML document.
div	the identifier (id) of the HTML element (typically a div ) in which the plot will be displayed. This is used to position the JavaScript code after this node.
isFile	a logical value that indicates whether code is the name of a file or the actual contents. This allows us to put the code in a file and then reference that file. This can be useful if we want to edit the JavaScript file separately.

Value

If out is not empty, the name of the resulting file. If out is empty, the contents of the HTML document as a parsed tree.

Author(s)

Duncan Temple Lang

See Also

d3Device d3Plot

Examples

 dev = d3Device()
 with(mtcars, plot(wt, mpg))
 abline(fit <- lm(mpg ~ wt, mtcars), lty = 2, col = "red")
 dev.off()

 code = dev$getCode()
 cir =  names(code) == "circle" 
 code[cir] = mapply(function(code, id) {
             c(code, sprintf("el.append(\"svg:title\").text(\"%s\");", id))
       }, code[cir], rownames(mtcars), SIMPLIFY = FALSE)

 addToHTMLTemplate(code, "mtcars.html")

duncantl/RD3Device documentation built on May 15, 2019, 5:28 p.m.