In cpsievert/runpkg: Tools for working with 'UNPKG'

knitr::opts_chunk$set(
  message = FALSE,
  comment = "#>",
  collapse = TRUE
)

An R package for working with unpkg -- content delivery network (CDN) for everything on npm. The goal is to make it easy to find, download, and manage any file from any npm package in R by storing them as htmltools::htmlDependency() objects.

Installation

runpkg is not available on CRAN, but you may install with:

devtools::install_github('cpsievert/runpkg')

Overview

Many npm packages distribute a 'main' file which provides the 'primary entry point to the program'. The download_main() function downloads that file and returns a htmltools::htmlDependency() object, which makes it easy to incorporate these dependencies in other R projects that leverage htmltools (e.g., shiny and htmlwidgets).

library(runpkg)
(jq_main <- download_main("jquery"))

library(htmltools)
cat(renderDependencies(list(jq_main), "href"))
cat(renderDependencies(list(jq_main), "file"))

Sometimes you want/need additional files from a package, especially if that package distributes optional dependencies. In this case, you may want to see what other files are distributed with the package via the ls_() function:

ls_("jquery")
ls_("jquery", "dist")
ls_("jquery@3.2.1", "external/sizzle")

Once you've targetted your file(s) of interest, use download_files() to acquire those files

files <- c(
  "dist/jquery.slim.min.js",
  "external/sizzle/dist/sizzle.min.js"
)
jq_full <- download_files("jquery", files)
cat(renderDependencies(list(jq_full), "file"))

Storing local files

If you need to store your dependencies in a special location, provide a relevant path to the "runpkg.path" option:

options(runpkg.path = system.file(package = "runpkg"))
(jq_main <- download_main("jquery"))
cat(renderDependencies(list(jq_main), "file"))

cpsievert/runpkg documentation built on May 4, 2019, 1:08 p.m.