download_file: Download a local file or multiple files

In downloadthis: Implement Download Buttons in 'rmarkdown'

Download a local file or multiple files

Description

In case multiple files are chosen, the files will be converted to a .zip file.

Usage

download_file(
  path,
  output_name,
  button_label = "Download data",
  button_type = c("default", "primary", "success", "info", "warning", "danger"),
  has_icon = TRUE,
  icon = "fa fa-save",
  self_contained = FALSE,
  ...
)

Arguments

path	Path to the file(s). If multiple files are chosen, a vector must be passed to this argument.
output_name	Name of of the output file. If not specified, it will take the source file's name if one file is specified. In case of multiple files, the output_name must be specified.
button_label	Character (HTML), button label
button_type	Character, one of the standard Bootstrap types
has_icon	Specify whether to include fontawesome icons in the button label
icon	Fontawesome tag e.g.: "fa fa-save"
self_contained	A boolean to specify whether your HTML output is self-contained. Default to FALSE.
...	attributes (named arguments) and children (unnamed arguments) of the button, passed to htmltools::tag().

Value

htmltools::tag, <button>

Examples

## Not run: 
## One file example
download_file(
  path = system.file("assets/css/all.min.css", package = "downloadthis"),
  output_name = "CSS file from downloadthis",
  button_label = "Download css file",
  button_type = "danger",
  has_icon = TRUE,
  icon = "fa fa-save",
  self_contained = FALSE
)

## Multiple files example
path_files <- list.files(
  path = system.file("assets/css", package = "downloadthis"),
  full.names = TRUE
)

download_file(
  path = path_files,
  output_name = "Files from downloadthis",
  button_label = "Download files",
  button_type = "danger",
  has_icon = TRUE,
  icon = "fa fa-save",
  self_contained = FALSE
)

## End(Not run)

downloadthis documentation built on Oct. 14, 2024, 5:07 p.m.