summary.sigma_metric: Summary method for sigma_metric objects

View source: R/sigma_metric.R

summary.sigma_metricR Documentation

Summary method for sigma_metric objects

Description

Provides a detailed summary of the sigma metric calculation, including the formula and interpretation scale.

Usage

## S3 method for class 'sigma_metric'
summary(object, ...)

Arguments

object

An object of class sigma_metric.

...

Additional arguments (currently ignored).

Value

Invisibly returns the object.

Examples

sm <- sigma_metric(bias = 1.5, cv = 2.0, tea = 10)
summary(sm)


valytics documentation built on Feb. 19, 2026, 5:06 p.m.