summary.welfareDecisionAnalysis: Summarize Welfare Decision Analysis results.

View source: R/welfareDecisionAnalysis.R

summary.welfareDecisionAnalysisR Documentation

Summarize Welfare Decision Analysis results.

Description

Produce a summary of the results of a welfare decision analysis obtained by the function welfareDecisionAnalysis.

Usage

## S3 method for class 'welfareDecisionAnalysis'
summary(
  object,
  ...,
  digits = max(3, getOption("digits") - 3),
  probs = c(0.05, 0.5, 0.95)
)

Arguments

object

An object of class welfareDecisionAnalysis.

...

Further arguments passed to format.

digits

how many significant digits are to be used for numeric and complex x. The default, NULL, uses getOption("digits"). This is a suggestion: enough decimal places will be used so that the smallest (in magnitude) number has this many significant digits, and also to satisfy nsmall. (For the interpretation for complex numbers see signif.)

probs

numeric vector: quantiles that shall be displayed; if =NULL no quantiles will be displayed.

Value

An object of class summary.welfareDecisionAnalysis.

See Also

welfareDecisionAnalysis, print.summary.welfareDecisionAnalysis, format


decisionSupport documentation built on Oct. 6, 2023, 1:06 a.m.