summary.ba_analysis: Summary method for ba_analysis objects

View source: R/ba_methods.R

summary.ba_analysisR Documentation

Summary method for ba_analysis objects

Description

Provides a detailed summary of Bland-Altman analysis results, including additional diagnostics and descriptive statistics.

Usage

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

Arguments

object

An object of class ba_analysis.

...

Additional arguments (currently ignored).

Value

An object of class summary.ba_analysis containing:

call

The original function call.

n

Number of paired observations.

n_excluded

Number of pairs excluded due to NAs.

var_names

Variable names for x and y.

type

Type of difference calculation.

conf_level

Confidence level used.

descriptives

Data frame with descriptive statistics.

agreement

Data frame with agreement statistics.

normality_test

Shapiro-Wilk test result for differences.

Examples

set.seed(42)
method_a <- rnorm(50, mean = 100, sd = 15)
method_b <- method_a + rnorm(50, mean = 2, sd = 5)
ba <- ba_analysis(method_a, method_b)
summary(ba)


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