finish-methods: Finalizing reports after publishing results

Description Methods Examples

Description

This is a method for finalizing a report after results have been published. The exact nature of finalizing depends on the report type, as detailed below.

Methods

signature(publicationType = "DataPackage")

Calling finish on a DataPackage object rewrites the DESCRIPTION file, making sure that all of the dependencies for the objects in the DataPackage are listed.

signature(publicationType = "HTMLReport")

Calling finish on an HTMLReport calls the hwrite function closePage, which closes the body and html tags on the page and closes the connection to the file.

signature(publicationType = "HTMLReportRef")

Calling finish on an HTMLReportRef calls all the finish handler for all ReportHandlers attached to the report. These handlers perform various actions depending on the desired behavior of the report.

Examples

1
2
3
4
5
my.df <- data.frame()
## html.report <- HTMLReport(shortName = "my_html_file",
##     reportDirectory = "reportDirectory")
# publish(my.df, html.report)
## finish(html.report)


Search within the ReportingTools package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.