Skip to contents

[Stable]

Generates a report for a completed run

Usage

PM_report(x, template, path, show = TRUE, quiet = TRUE)

Arguments

x

A PM_result object obtained from PM_load.

template

Report mode. One of "app", "plotly", "ggplot", or "none". If omitted, uses the report_template Pmetrics option. An invalid value falls back to that saved default.

path

Output directory for HTML reports.

show

Controls whether the report should be opened automatically, defaults to TRUE.

quiet

Suppress output from HTML report rendering.

Value

Invisibly returns 1 on success, 0 when reporting is disabled, and -1 when no report can be generated.

See also

Author

Markus Hovd, Julian Otalvaro, and Michael Neely