readReport: Read in an Existing Report

In JasonHackney/ReportingTools: Tools for making reports in various formats

Read in an Existing Report

Description

This function is used to read an existing Report (previously created using ReportingTools) into R so that it can modified or computed on.

Usage

readReport(reportFile, handlers = fileHandlers(reportFile), 
  .toHTML = NULL, .toDF = NULL, .modifyDF = NULL, title)

Arguments

reportFile	A character value pointing to the HTML file containing an existing Report.
handlers	The ReportHandlers object(s) to attach to the resulting HTMLReportRef object.
.toHTML	The list of .toHTML overrides to attach to the HTMLReportRef object
.toDF	The list of .toDF overrides to attach to the HTMLReportRef object
.modifyDF	The list of .modifyDF overrides to attach to the HTMLReportRef object
title	Title to assign to the new HTMLReportRef object. If not specified this value is inferred from the file.

Value

An HTMLReportRef object representing the Report.

Note

Attempting to write the modified report to a new location without updating any report elements involving figures will result in broken image links because image locations are assumed to be relative to the location of the HTML file.

Author(s)

Gabriel Becker

See Also

HTMLReportRef

JasonHackney/ReportingTools documentation built on Oct. 23, 2023, 9:24 p.m.