download_this: Download data frames, lists, or any R object
In downloadthis: Implement Download Buttons in 'rmarkdown'

download_this

R Documentation

Download data frames, lists, or any R object

Description

Wrapper around bsplus::bs_button() to provide a download button for HTML outputs in R Markdown. Internally, the function writes the file to tempdir(), encodes it, and produces the download button. Currently, Internet Explorer does not support downloading embedded files. For downloading links, files, or directories, see download_link(), download_file(), and download_dir().

Usage

download_this(
  .data,
  ...,
  output_name = NULL,
  output_extension = c(".csv", ".xlsx", ".rds"),
  button_label = "Download data",
  button_type = c("default", "primary", "success", "info", "warning", "danger"),
  icon = "fa fa-save",
  self_contained = FALSE,
  csv2 = TRUE,
  ggsave_args = list()
)

Arguments

`.data`	A data frame or (named) list to write to disk. See 'Examples' for more details.
`...`	attributes (named arguments) and children (unnamed arguments) of the button, passed to `htmltools::tag()`.
`output_name`	Name of of the output file, if `NULL` uses the deparsed `.data` object.
`output_extension`	Extension of the output file. Currently, `.csv`, `.xlsx`, and `.rds` are supported. If a (named) list is passed to the function, only `.xlsx` and `.rds` are supported.
`button_label`	Character (HTML), button label
`button_type`	Character, one of the standard Bootstrap types
`icon`	Fontawesome tag e.g.: "fa fa-save", set to `NULL` to not show any icon.
`self_contained`	A boolean to specify whether your HTML output is self-contained. Default to `FALSE`.
`csv2`	A boolean to specify whether to use `readr::write_csv2()` in case the `output_extension` is chosen as '.csv'. If `FALSE`, `readr::write_csv()` will be used instead. Default to `TRUE`.
`ggsave_args`	List of arguments to pass to `ggplot2::ggsave`, e.g.: `list(height = 5)`.

Value

htmltools::tag, <button>

Warning

This example will write the mtcars dataset to tempdir() and produce the download button for the file ⁠mtcars dataset.csv⁠ with the ⁠fa fa-save⁠ icon on the ⁠Download data⁠ label.

Examples

## Not run: 
# Passing a data frame to the function
mtcars %>%
  download_this(
    output_name = "mtcars dataset",
    output_extension = ".csv",
    button_label = "Download data",
    button_type = "warning",
    icon = "fa fa-save"
  )

# Passing a list with data frames to the function
list(mtcars, iris) %>%
  download_this(
    output_name = "mtcars and iris datasets",
    output_extension = ".xlsx",
    button_label = "Download data",
    button_type = "warning",
    icon = "fa fa-save"
  )

# Passing a named list with data frames to the function
list("mtcars dataset" = mtcars, "iris dataset" = iris) %>%
  download_this(
    output_name = "mtcars and iris datasets",
    output_extension = ".xlsx",
    button_label = "Download data",
    button_type = "warning",
    icon = "fa fa-save"
  )

# Passing any R object to the function
vector_example <- 1:10
linear_model <- lm(mpg ~ gear, data = mtcars)

list(mtcars, iris, vector_example, linear_model) %>%
  download_this(
    output_name = "datasets, vector, and linear model",
    output_extension = ".rds",
    button_label = "Download as rds",
    button_type = "warning",
    icon = "fa fa-save"
  )

## End(Not run)

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