generateReport: Generate a report to show the fitted distributions

In SHELF: Tools to Support the Sheffield Elicitation Framework

Generate a report to show the fitted distributions

Description

Renders an Rmarkdown document to display the density function of each fitted distribution, the parameter values, and the R command required to sample from each distribution.

Usage

generateReport(
  fit,
  output_format = "html_document",
  sf = 3,
  expert = 1,
  view = TRUE,
  clean = TRUE
)

Arguments

fit	An object of class 'elicitation'.
output_format	the output format for the document. One of "html_document", "pdf_document" (requires LaTeX to be installed), or "word_document" (requires Word to be installed).
sf	number of significant figures to be displayed for the fitted parameters.
expert	if the fit object contains judgements from multiple experts, the single expert's distributions to be displayed.
view	set to TRUE to open the document after it has been compiled.
clean	set to TRUE to clean intermediate files that are created during rendering.

Examples

## Not run: 
# One expert, with elicited probabilities
# P(X<20)=0.25, P(X<30)=0.5, P(X<50)=0.75
# and X>0.
v <- c(20,30,50)
p <- c(0.25,0.5,0.75)
myfit <- fitdist(vals=v, probs=p, lower=0)

generateReport(myfit)

## End(Not run)

SHELF documentation built on Sept. 11, 2024, 6:54 p.m.