R/self_vignette_engine.R
In HenrikBengtsson/TopDomStudy: TopDom Study by Segal et al.
Defines functions
register_vignette_engine
register_vignette_engine <- function(pkgname) {
tools::vignetteEngine("self", package = pkgname, pattern = "[.]md$",
weave = function(file, ...) {
output <- sprintf("%s.html", tools::file_path_sans_ext(basename(file)))
md <- readLines(file)
title <- grep("%\\VignetteIndexEntry{", md, fixed = TRUE, value = TRUE)
title <- gsub(".*[{](.*)[}].*", "\\1", title)
md <- grep("%\\\\Vignette", md, invert = TRUE, value = TRUE)
## Inject vignette title
md <- c(sprintf("# %s\n\n", title), md)
html <- commonmark::markdown_html(md, smart = TRUE, extensions = TRUE,
normalize = FALSE)
css <- readLines("incl/clean.css", warn = FALSE)
## Inject HTML environment
html <- c("<!DOCTYPE html>",
"<html lang=\"en\">",
"<head>",
sprintf("<title>%s</title>", title),
"<style>", css, "</style>",
"</head>",
"<body>", html, "</body>",
"</html>")
html <- paste(html, collapse = "\n")
html <- enc2utf8(html)
cat(html, file = output)
cat(html, file = "~/foo.html")
output
},
tangle = function(file, ...) {
## As of R 3.3.2, vignette engines must produce tangled output, but as
## long as it contains all comments then 'R CMD build' will drop it.
output <- sprintf("%s.R", tools::file_path_sans_ext(basename(file)))
cat(sprintf("### This is an R script tangled from %s\n",
sQuote(basename(file))), file = output)
output
}
)
}
HenrikBengtsson/TopDomStudy documentation built on May 14, 2021, 1:49 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions register_vignette_engine
register_vignette_engine <- function(pkgname) {
tools::vignetteEngine("self", package = pkgname, pattern = "[.]md$",
weave = function(file, ...) {
output <- sprintf("%s.html", tools::file_path_sans_ext(basename(file)))
md <- readLines(file)
title <- grep("%\\VignetteIndexEntry{", md, fixed = TRUE, value = TRUE)
title <- gsub(".*[{](.*)[}].*", "\\1", title)
md <- grep("%\\\\Vignette", md, invert = TRUE, value = TRUE)
## Inject vignette title
md <- c(sprintf("# %s\n\n", title), md)
html <- commonmark::markdown_html(md, smart = TRUE, extensions = TRUE,
normalize = FALSE)
css <- readLines("incl/clean.css", warn = FALSE)
## Inject HTML environment
html <- c("<!DOCTYPE html>",
"<html lang=\"en\">",
"<head>",
sprintf("<title>%s</title>", title),
"<style>", css, "</style>",
"</head>",
"<body>", html, "</body>",
"</html>")
html <- paste(html, collapse = "\n")
html <- enc2utf8(html)
cat(html, file = output)
cat(html, file = "~/foo.html")
output
},
tangle = function(file, ...) {
## As of R 3.3.2, vignette engines must produce tangled output, but as
## long as it contains all comments then 'R CMD build' will drop it.
output <- sprintf("%s.R", tools::file_path_sans_ext(basename(file)))
cat(sprintf("### This is an R script tangled from %s\n",
sQuote(basename(file))), file = output)
output
}
)
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.