summary.vs_decomp: Summary Method for 'vs_decomp' Objects

Description Usage Arguments Value

View source: R/summary.R

Description

Summary Method for 'vs_decomp' Objects

Usage

1
2
## S3 method for class 'vs_decomp'
summary(object, r = 3, sum.comp = NULL, ...)

Arguments

object

a 'vs_decomp' object.

r

a number of decimal places to use.

sum.comp

a vector of up to 3 components to summarize. can be either character with component names or numeric with component indices. other components not specified by sum.comp are summed to one additional component. default is to summarize the first 3 components.

...

further arguments passed to or from other methods.

Value

No return value.


VSdecomp documentation built on May 18, 2021, 9:06 a.m.