build_webreport: Build a report from a source file

In NESREA/webreport: Reporting on Social Media and Websites Made Easy

Description

Creates a report from an R Markdown template file that is found in the package (precisely in inst/rmarkdown) and utilises a data previously stored in a local database.

Usage

build_webreport(data.source, launch = TRUE, ...)

Arguments

data.source	A database file containing web data
launch	logical; whether to automatically open built document
...	Additional arguments passed to rmarkdown::render().

Details

data.source refers to a SQLite file (internally) wherein the data for the analysis are stored. The function supports the file extensions .sqlite and .db. The data are expected to have been stored with the structure defined by the various social media platform APIs.

outfile currently has to be a document with extension .docx. Support for other file formats is planned in future upgrades. By default, a file name is automatically supplied - this name is always unique as it bears a timestamp. By default, the file is saved in the current working directory.

The document is opened, by default, when launch.file is TRUE If FALSE is passed, the document is saved and a message is sent to the user stating the save location.

Arguments can be passed to rmarkdown::render() such as output_dir i.e. the directory where the built document is stored

Value

This function has no return value. The result of the operation is a document built in the specified file format.

See Also

render

NESREA/webreport documentation built on May 22, 2019, 1:58 p.m.