inst/template/R/assets.R
In devOpifex/leprechaun: Create Simple 'Shiny' Applications as Packages
#---------------------------------------------#
# DO NOT EDIT THIS FILE OR ADD ANYTHING TO IT #
#---------------------------------------------#
#' Dependencies
#'
#' @param modules JavaScript files names that require
#' the `type = module`.
#' @param ignore A vector of files to ignore.
#' This can be useful for scripts that should not be
#' placed in the `<head>` of the HTML.
#' @importFrom htmltools htmlDependency
#'
#' @keywords internal
serveAssets <- function(modules = NULL, ignore = c()) {
# JavaScript files
javascript <- list.files(
system.file(package = "#PKGNAME#"),
recursive = TRUE,
pattern = ".js$"
)
modules <- get_modules(javascript, modules)
javascript <- remove_modules(javascript, modules)
# CSS files
css <- list.files(
system.file(package = "#PKGNAME#"),
recursive = TRUE,
pattern = ".css$"
)
# exclude specifically html/R.css from a built package
# solves https://github.com/devOpifex/leprechaun/issues/4
css <- css[css != "html/R.css"]
# so dependency processes correctly
names(css) <- rep("file", length(css))
names(javascript) <- rep("file", length(javascript))
# remove ignored files
if (length(ignore) > 0) {
ignore_pat <- paste0(ignore, collapse = "|", sep = "$")
css <- css[!grepl(ignore_pat, css)]
javascript <- javascript[!grepl(ignore_pat, javascript)]
}
# serve dependencies
dependencies <- list()
standard <- htmlDependency(
"#PKGNAME#",
version = utils::packageVersion("#PKGNAME#"),
package = "#PKGNAME#",
src = ".",
script = javascript,
stylesheet = css
)
dependencies <- append(dependencies, list(standard))
if (!is.null(modules)) {
modules <- htmlDependency(
"#PKGNAME#-modules",
version = utils::packageVersion("#PKGNAME#"),
package = "#PKGNAME#",
src = ".",
script = modules,
meta = list(type = "module")
)
dependencies <- append(dependencies, list(modules))
}
return(dependencies)
}
#' Module
#'
#' Retrieve and add modules from a vector of files.
#'
#' @param files JavaScript files
#' @param modules JavaScript files names that require
#' the `type = module`.
#' @importFrom htmltools htmlDependency
#'
#' @keywords internal
#' @name js-modules
remove_modules <- function(files, modules) {
if (is.null(modules)) return(files)
# make pattern
pattern <- collapse_files(modules)
# remove modules
files[!grepl(pattern, files)]
}
#' @rdname js-modules
#' @keywords internal
get_modules <- function(files, modules) {
if (is.null(modules)) return(NULL)
# make pattern
pattern <- collapse_files(modules)
# remove modules
files[grepl(pattern, files)]
}
# collapse files into a pattern
collapse_files <- function(files) {
pattern <- paste0(files, collapse = "$|")
paste0(pattern, "$")
}
#---------------------------------------------#
# DO NOT EDIT THIS FILE OR ADD ANYTHING TO IT #
#---------------------------------------------#
devOpifex/leprechaun documentation built on April 17, 2025, 4:31 a.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.
#---------------------------------------------#
# DO NOT EDIT THIS FILE OR ADD ANYTHING TO IT #
#---------------------------------------------#
#' Dependencies
#'
#' @param modules JavaScript files names that require
#' the `type = module`.
#' @param ignore A vector of files to ignore.
#' This can be useful for scripts that should not be
#' placed in the `<head>` of the HTML.
#' @importFrom htmltools htmlDependency
#'
#' @keywords internal
serveAssets <- function(modules = NULL, ignore = c()) {
# JavaScript files
javascript <- list.files(
system.file(package = "#PKGNAME#"),
recursive = TRUE,
pattern = ".js$"
)
modules <- get_modules(javascript, modules)
javascript <- remove_modules(javascript, modules)
# CSS files
css <- list.files(
system.file(package = "#PKGNAME#"),
recursive = TRUE,
pattern = ".css$"
)
# exclude specifically html/R.css from a built package
# solves https://github.com/devOpifex/leprechaun/issues/4
css <- css[css != "html/R.css"]
# so dependency processes correctly
names(css) <- rep("file", length(css))
names(javascript) <- rep("file", length(javascript))
# remove ignored files
if (length(ignore) > 0) {
ignore_pat <- paste0(ignore, collapse = "|", sep = "$")
css <- css[!grepl(ignore_pat, css)]
javascript <- javascript[!grepl(ignore_pat, javascript)]
}
# serve dependencies
dependencies <- list()
standard <- htmlDependency(
"#PKGNAME#",
version = utils::packageVersion("#PKGNAME#"),
package = "#PKGNAME#",
src = ".",
script = javascript,
stylesheet = css
)
dependencies <- append(dependencies, list(standard))
if (!is.null(modules)) {
modules <- htmlDependency(
"#PKGNAME#-modules",
version = utils::packageVersion("#PKGNAME#"),
package = "#PKGNAME#",
src = ".",
script = modules,
meta = list(type = "module")
)
dependencies <- append(dependencies, list(modules))
}
return(dependencies)
}
#' Module
#'
#' Retrieve and add modules from a vector of files.
#'
#' @param files JavaScript files
#' @param modules JavaScript files names that require
#' the `type = module`.
#' @importFrom htmltools htmlDependency
#'
#' @keywords internal
#' @name js-modules
remove_modules <- function(files, modules) {
if (is.null(modules)) return(files)
# make pattern
pattern <- collapse_files(modules)
# remove modules
files[!grepl(pattern, files)]
}
#' @rdname js-modules
#' @keywords internal
get_modules <- function(files, modules) {
if (is.null(modules)) return(NULL)
# make pattern
pattern <- collapse_files(modules)
# remove modules
files[grepl(pattern, files)]
}
# collapse files into a pattern
collapse_files <- function(files) {
pattern <- paste0(files, collapse = "$|")
paste0(pattern, "$")
}
#---------------------------------------------#
# DO NOT EDIT THIS FILE OR ADD ANYTHING TO IT #
#---------------------------------------------#
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.