summary.riskyr: Summarize a riskyr scenario.

View source: R/riskyr_class.R

summary.riskyrR Documentation

Summarize a riskyr scenario.

Description

summary.riskyr provides a summary method for objects of class "riskyr".

Usage

## S3 method for class 'riskyr'
summary(object = NULL, summarize = "all", ...)

Arguments

object

An object of class "riskyr", usually a result of a call to riskyr. Inbuilt scenarios are also of type "riskyr".

summarize

What is summarized as a vector consisting of c("freq", "prob", "accu") for frequencies, probabilities, and accuracy respectively. The default "all" is an alias to all three.

...

Additional parameters (to be passed to summary functions).

Format

An object of class summary.riskyr with up to 9 entries.

Value

A summary list obj.sum with up to 9 entries, dependent on which information is requested by summarize.

Scenario name, relevant condition , and N are summarized by default.

See Also

riskyr initializes a riskyr scenario.

Other riskyr scenario functions: plot.riskyr(), riskyr()

Examples

summary(scenarios$n4)


riskyr documentation built on Aug. 15, 2022, 9:09 a.m.