reportHTML: Generic Function for Automatic HTML Report Generation

Description Usage Arguments Value Author(s) See Also Examples

View source: R/reportHTML.R

Description

When a standard analysis is applied to some object it is useful to keep all the plots and summaries related to that analysis in a single place where they can be easily accessed and visualized. An html file containing the report of this analysis is ideally suited for that. The methods reportHTML generate such reports.

Usage

1
reportHTML(object, filename, extension, directory, Title, ...)

Arguments

object

an object from which the report is going to be generated, perhaps following some standard analysis procedure.

filename

a character string. The generic name of all the files (html, png as well as R data files which will be generated. See also HTMLInitFile.

extension

see HTMLInitFile.

directory

the full or relative path to the directory where the results are going to be stored. See also HTMLInitFile.

Title

See HTMLInitFile. If missing a default value baed on filename is provided.

...

additional parameters passed to the functions internally called by the actual methods.

Value

Nothing is returned, an html file and figures in png format are written to disk together with the R variables generated during the analysis , if an analysis was performed.

Author(s)

Christophe Pouzat [email protected]

See Also

reportHTML.spikeTrain, reportHTML.repeatedTrain, reportHTML.gam

Examples

1
##

STAR documentation built on May 30, 2017, 3:06 a.m.