print.sigma_metric: Print method for sigma_metric objects

View source: R/sigma_metric.R

print.sigma_metricR Documentation

Print method for sigma_metric objects

Description

Displays a concise summary of the sigma metric calculation.

Usage

## S3 method for class 'sigma_metric'
print(x, digits = 2, ...)

Arguments

x

An object of class sigma_metric.

digits

Number of decimal places to display (default: 2).

...

Additional arguments (currently ignored).

Value

Invisibly returns the input object x.

Examples

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


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