make_report: Prepare and render the HTML5 report

View source: R/make_report.R

make_reportR Documentation

Prepare and render the HTML5 report

Description

This script generates the HTML5 report based on an enriched 'CALANGO'-type list output by 'run_CALANGO()'.

Usage

make_report(defs, render.report = TRUE)

Arguments

defs

an enriched 'CALANGO'-type list generated by 'run_CALANGO()'

render.report

logical: should the HTML5 report be generated (for internal use only)

Value

Updated 'defs' list, containing:

  • All input parameters originally passed (see [run_CALANGO()] for details).

  • Derived fields calculated for displaying the results, including several statistical summaries of the data (including correlations, contrasts, covariances, p-values).

This function is mainly called for its side effect, namely the generation of an HTML5 report of the analysis, which is saved to the folder indicated in 'defs$output.dir'.


CALANGO documentation built on April 26, 2023, 5:13 p.m.