autoReport {voiceR}

Generate a Summary Report

Description

Generates a summary report containing the output of autoExtract(), normalityPlots() and comparisonPlots().

Usage

autoReport(
  audioData,
  savePath = getwd(),
  includeDimensions = FALSE,
  avoidNormalCheck = c(),
  filename = "voiceR_report.html"
)

Arguments

audioData

A data.frame generated by autoExtract() function.

savePath

Character string indicating the full path to the folder to which we want to save the generated report. By default it is set to the current working directory.

includeDimensions

Logical value indicating whether Dimensions should be also included as a factor or not. Default corresponds to FALSE.

avoidNormalCheck

Logical vector, indicating if and what variables' distribution were transformed to normal. By default it is set to FALSE for each of the measures. Alternatively, you can set it to TRUE to avoid checking normality for all the measures.

filename

Optional character string indicating the file name of the generated report. Default corresponds to "voiceR_report.html".

Value

html report file, which is saved in the selected path, but returns nothing.

Examples

autoReport(testAudioData = testAudioData)