HTMLReport-class: Class '"HTMLReport"'

Description Objects from the Class Slots Extends Methods

Description

This class has been superceded by HTMLReportRef and is deprecated. The HTMLReport constructor function now creates an HTMLReportRef object.

Objects from the Class

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

Slots

baseUrl:

What is the base URL to which the HTMLReport's filename is appended.

basePath:

What is the base file system URI to which the HTMLReport's filename is appended.

page:

The connection to the html file. See openPage in the hwriter package.

shortName:

A character string used as the base of the filename. '.html' is appended to the shortName to make the full file name.

title:

The title of the HTMLReport. This is used as the page title in the header, and is also printed on the page.

reportDirectory:

A file path that details where the report will be saved.

Extends

Class "BaseReport", directly.

Methods

basePath

Return the basePath for the HTMLReport

baseUrl

Return the baseUrl for the HTMLReport

filename

Return the file name of the HTMLReport. This is generated by adding '.html' to the shortName of the report.

finish

This is the final step in publishing results to an HTMLReport. It prints the closing tags for the html body, and then closes the connection to the html file. Further calls to publish will fail because the connection is closed.

name<-

Set the short name for the html file.

page

Returns the connection to the html file.

page<-

Set the connection to the html file.

validConnection

Is the connection to the html file still open? If finish has been called, this will return FALSE.


Bioconductor-mirror/ReportingTools documentation built on July 28, 2017, 4:28 a.m.