ReportHandlers-class: Class '"ReportHandlers"'

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

Class "ReportHandlers"

Description

A set of event-handler functions to be called when certain actions are performed on a HTMLReportRef object.

Details

ReportingTools ships with a number of predefined ReportHandlers constructorslo functions which generate ReportHandlers objects which implement commonly desired behaviors:

fileHandlers

Accepts destination file location in the form of a character value, which is stored in the object's location slot. Report is built up internally and written to a file via the finish observer.

fileWIndexHandlers

As with fileHandlers except that a table of contents is appended to the be beginning of the report with links to each element within the page. Link text is the element names

connectionHandlers

Accepts a connection to which the report should be streamed (which is stored in the location slot). Report is streamed out to the provided connection as elements are added to the report. codefinish completes the page and closes the connection.

knitrHandlers

Accepts an option filename argument which will be stored as the location slot, but is not used internally. Elements are streamed in HTML form to standard output, which is captured by knitr and inserted into the page, allowing ReportingTools to be used as a formatting mechanism to publish objects within a knitr document and have them displayed correctly. Note: location MUST match the output file actually generated by the knitr/knit2html call (at least up to destination directory). If it does not the resulting page will not function properly.

shinyHandlers

These handlers allow ReportingTools to be used as a formatting mechanism within a shiny Web application. Note in this case there is no meaninggful HTML file being created that represents the report. location is set to NULL as no meaningful location exists in the shiny case.

Objects from the Class

Objects can be created by calls of the form new("ReportHandlers", ...).

Slots

init:

A function to be called when the report is initialized/created

addElement:

A function to be called when an element is added/published to the report

removeElement:

A function to be called when an element is removed from the report

finish:

A function to be called when the report is "finished"

args:

A named list containing zero or more of the elements "init", "addElement", "removeElement", and "finish", which contain additional arguments to be passed to the respective functions when called.

location:

An R object indicating the location these handlers will publish the report to. The exact meaning of this argument depends on the behavior of the handlers.

Methods

path

signature(object = "ReportHandlers"): For file handlers, the file system location where the file will be written. For all others, NULL.

Methods

path

Returns the location associated with these ReportHandlers

Author(s)

Gabriel Becker <[e-mail]>

See Also

HTMLReportRef

Examples

showClass("ReportHandlers")

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