reportHTML: Generic Function for Automatic HTML Report Generation

In STAR: Spike Train Analysis with 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

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 [e-mail]

See Also

reportHTML.spikeTrain, reportHTML.repeatedTrain, reportHTML.gam

Examples

##

Example output

Loading required package: survival
Loading required package: mgcv
Loading required package: nlme
This is mgcv 1.8-28. For overview type 'help("mgcv-package")'.
Loading required package: R2HTML
Loading required package: gss
Loading required package: codetools

STAR documentation built on May 2, 2019, 11:44 a.m.