BaseReportType-class: Class '"BaseReport"'

In ReportingTools: Tools for making reports in various formats

Description

A ReportType defines a way of representing an R object in a different, ordered format. Several ReportTypes have been detailed in this package, including classes for HTML reports and R data packages.

Objects from the Class

Objects can be created by calls of the form new("BaseReport", ...). This is an abstract class that is inherited by other ReportTypes, and should not be used directly.

Slots

shortName:

A character string generally used as the filename for reports

title:

A character string that gives a longer description of what the report shows.

reportDirectory:

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

Methods

name

signature(object = "BaseReport"): Get the shortName assigned to the report.

reportDirectory

signature(object = "BaseReport"): Get the directory where the report will be generated.

reportDirectory<-

signature(object = "BaseReport", value = "character"): Set the directory where the report will be generated.

show

signature(object = "BaseReport"): ...

title

signature(main = "BaseReport"): Return the title of the report

title<-

signature(object = "BaseReport", value = "character"): Set the title of the report.

path

signature(object = "BaseReport"): Get the filesystem location of the report.

See Also

HTMLReport DataPackage CSVFile

Examples

showClass("BaseReport")

ReportingTools documentation built on March 10, 2021, 2 a.m.