Skip to contents

report() takes an object of class jfaEvaluation as returned by the evaluation() function automatically generates a html or pdf report of the results.

For more details on how to use this function, see the package vignette: vignette('jfa', package = 'jfa')

Usage

report(object, file = 'report.html', format = c('html_document', 'pdf_document'))

Arguments

object

an object of class jfaEvaluation as returned by the evaluation() function.

file

a character specifying the name of the report (e.g. report.html).

format

a character specifying the output format of the report. Possible options are html_document (default) and pdf_document, but compiling to pdf format requires a local version of MikTex.

Value

A html or pdf file containing a report of the evaluation.

Author

Koen Derks, k.derks@nyenrode.nl

Examples

data("BuildIt")

# Draw a sample of 100 monetary units from the population using
# fixed interval monetary unit sampling
sample <- selection(
  data = BuildIt, size = 100, method = "interval",
  units = "values", values = "bookValue"
)$sample

# Evaluate using the Stringer bound
result <- evaluation(
  conf.level = 0.95, materiality = 0.05, method = "stringer",
  data = sample, values = "bookValue", values.audit = "auditValue"
)
if (FALSE) {
report(result)
}