summary: Displays a Useful Description of a Distribution Object

Distribution_summaryR Documentation

Displays a Useful Description of a Distribution Object

Description

Displays a useful description of a distribution object from mistr.

Usage

## S3 method for class 'standist'
summary(object, level = 1, space = 2, additional_list, truncation, ...)

## S3 method for class 'trans_standist'
summary(object, level = 1, space = 2, additional_list, truncation, ...)

## S3 method for class 'mixdist'
summary(object, level = 1, space = 2, additional_list, truncation, ...)

## S3 method for class 'trans_mixdist'
summary(object, level = 1, space = 2, additional_list, truncation, ...)

## S3 method for class 'compdist'
summary(object, level = 1, space = 2, additional_list, truncation, ...)

## S3 method for class 'trans_compdist'
summary(object, level = 1, space = 2, additional_list, truncation, ...)

Arguments

object

distribution object to summarize.

level

adds 3*(level-1) spaces before the print, default: 1.

space

number of blank lines between outputs, default: 2.

additional_list, truncation, ...

additional information that may be passed to summary.

Details

summary prints useful description of a distribution object. This feature might be useful when working with a more complicated distribution that contains mixture and composite distributions as components and the print function does not offer enough information.

Arguments level, additional_list and truncation are present for recursive usage that is done for more complicated models automatically by the function.


mistr documentation built on March 7, 2023, 7:42 p.m.