embed_file: Embed a file, multiple files, or directory on an HTML page
Description
For a file, first encode it into base64 data (a character string). Then
generate a hyperlink of the form <a href="base64 data"
download="filename">Download filename</a>. The file can be downloaded when
the link is clicked in modern web browsers. For a directory, it will be
compressed as a zip archive first, and the zip file is passed to
embed_file(). For multiple files, they are also compressed to a zip
file first.
Usage
embed_file(path, name = basename(path), text = paste("Download", name), ...)
embed_dir(path, name = paste0(normalize_path(path), ".zip"), ...)
embed_files(path, name = with_ext(basename(path[1]), ".zip"), ...)
Arguments
path
Path to the file(s) or directory.
name
The default filename to use when downloading the file. Note that
for embed_dir(), only the base name (of the zip filename) will be
used.
text
The text for the hyperlink.
...
For embed_file(), additional arguments to be passed to
htmltools::a() (e.g., class = 'foo'). For embed_dir()
and embed_files(), arguments passed to embed_file().
Value
An HTML tag <a> with the appropriate attributes.
Details
These functions can be called in R code chunks in R Markdown documents with
HTML output formats. You may embed an arbitrary file or directory in the HTML
output file, so that readers of the HTML page can download it from the
browser. A common use case is to embed data files for readers to download.
# NOT RUN {logo = file.path(R.home("doc"), "html", "logo.jpg")
link = xfun::embed_file(logo, "R-logo.jpg", "Download R logo")
link
htmltools::browsable(link)
# }