Generate a HTML report based on plots or comparisons

Share:

Description

Will produce a HTML report of the results from any of the qcPlot*, or qcCompare* results.

Usage

1
  writeReport(qcResult, browse = TRUE, xslStyleSheets = NULL)

Arguments

qcResult

one of:

  • an R object of class qcPlot*, or qcCompare*.

  • the path to the log file to report on

  • a path to the directory, where the highest classed log file will be auto-detected and then reported on (note that first comparison logs are searched for, then plot logs).

browse

A logical value indicating whether R should automatically open a browser to view the final report.

xslStyleSheets

a named list specifying which XSL style sheets to override by giving the name of the style sheet to override, and the location of the xsl file. Can override any of: “plotExprStyleSheet”, “plotFunAndFileStyleSheet”, “compareExprStyleSheet”, and “compareFunAndFileStyleSheet”. If none are specified, the default (system) ones are used.

Details

When reporting on an object, all further qcPlot* or qcCompare* files which the current object refers to are also reported on. This is so that full information reports can be given, along with individual breakdowns. In order for this to happen, all log files that the object currently being reported on refers to must exist, as well as any subsequent log files that they refer to.

All reports are placed in the same directory as the XML file they refer to, with the same name, except with the extension changed from ‘.xml’ to ‘.html’.

Value

A character vector giving the (absolute) path of the highest classed object reported on. Comparison logs are considered higher classed than plot logs.

See Also

plotExpr, plotFile, plotFunction, compare.

Examples

1
2
3
4
5
6
7
8
## Not run: 
  # After running the `?compare' example
  writeReport(compExpr)

  # Showing how to overwrite stylesheets
  # writeReport(compExpr, list(compareExprStyleSheet="~/myCompareExpr.xsl"))

## End(Not run)