finish-methods {ReportingTools} | R Documentation

## Finalizing reports after publishing results

### 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 `ReportHandler`s attached to the report. These handlers perform various actions depending on the desired behavior of the report.

### Examples

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

[Package ReportingTools version 2.26.0 Index]