Download: Create objects of class 'Download'

In humburg/reportmd: Scientific reports with RMarkdown

Description

Objects of this class hold the information necessary to create output files containing data and results from the analysis as well as the links necessary to access them from the HTML output.

Usage

Download(writer, file_name, label, description, ...)

Arguments

writer	A function to write the downloadable content to a file. Its first argument should be the R object to be written and the second argument the file name.
file_name	Name of output file, not including any path information.
label	A short, descriptive label to identify the download.
description	A longer description of the downloadable content.
...	Additional arguments are passed to writer.

Value

An object of class Download

Note

This class stores all the information necessary to create downloadable files, but creating an instance of this class will not create the file. Use add_download to add Instances of this class to the global list of downloads. All downloads registered in this way will be created automatically after the rest of the document has been processed and a section with download links is added to the appendix. Download links can be created manually through calls to create_download.

Author(s)

Peter Humburg

humburg/reportmd documentation built on May 17, 2019, 9:13 p.m.