jfa (version 0.5.5)

report: Create a statistical audit sampling report

Description

This function takes an object of class jfaEvaluation as returned by the evaluation() function automatically generates a html or pdf report containing the analysis results and their interpretation.

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

Usage

report(object, file = 'report.html', format = 'html_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). By default, the report is created in your current working directory.

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.

See Also

auditPrior planning selection evaluation auditBF

Examples

# NOT RUN {
data('BuildIt')

# Draw a sample of 100 monetary units from the population using
# fixed interval monetary unit sampling
sample <- selection(population = BuildIt, sampleSize = 100, 
          algorithm = 'interval', units = 'mus', bookValues = 'bookValue')$sample

# Evaluate using the Stringer bound
result <- evaluation(confidence = 0.95, materiality = 0.05, 
                     method = 'stringer', sample = sample, 
                     bookValues = 'bookValue', auditValues = 'auditValue')

# }
# NOT RUN {
 report(result) 
# }
# NOT RUN {
# }