statcheckReport: Generate HTML report for statcheck output.

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/statcheckReport.R

Description

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

Usage

1
statcheckReport(statcheckOutput, outputFileName, outputDir)

Arguments

statcheckOutput

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

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.

Value

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

Author(s)

Sacha Epskamp <mail@sachaepskamp.com> & Michele B. Nuijten

<m.b.nuijten@uvt.nl>

See Also

statcheck, checkPDF, checkHTMLdir, checkHTML, checkHTMLdir

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
  
  # first generate statcheck output, for instance by using the statcheck() function
  
  txt <- "blablabla the effect was very significant (t(100)=1, p < 0.001)"
  stat <- statcheck(txt)
  
  # next, use this output to generate a nice HTML report of the results
  
  statcheckReport(stat, outputFileName="statcheckHTMLReport", outputDir="C:/mydocuments/results")
  
## End(Not run)
  
  # you can now find your HTML report in the folder 
  # "C:/mydocuments/results" under the name "statcheckHTMLReport.html".
  

statcheck documentation built on May 2, 2019, 9:19 a.m.