Learn R Programming

statcheck (version 1.5.0)

statcheckReport: Generate HTML report for statcheck output

Description

This function uses R Markdown to generate a nicely formatted HTML report of statcheck output.

Usage

statcheckReport(statcheckOutput, outputFileName, outputDir)

Value

An HTML report, saved in the directory specified in the argument "outputDir".

Arguments

statcheckOutput

statcheck output of one of the following functions: statcheck, checkPDFdir, checkPDF, checkHTMLdir, checkHTML, or checkdir.

outputFileName

String specifying the file name under which you want to save the generated HTML report. The extension ".html" is automatically added, so doesn't need to be specified in this argument.

outputDir

String specifying the directory in which you want to save the generated HTML report.

Details

This function temporarily saves the inserted statcheck output as an .RData file in the "output" folder in the statcheck package directory. This file is then called by the .Rmd template that is saved in the folder "rmd", also in the statcheck package directory. After the HTML report is generated, the .RData file is removed again.