comparison_report: Full result contract of a comparison

View source: R/report.R

comparison_reportR Documentation

Full result contract of a comparison

Description

Returns every element the protocol promises: estimand, estimate, current confidence sequence, required assumptions, diagnostics, decision and stopping reason, resources consumed, seeds and versions. summary() is an alias.

Usage

comparison_report(state)

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

Arguments

state

A seqbench_comparison.

object

A seqbench_comparison.

...

Unused.

Value

A list of class seqbench_report.

Examples

state <- initialize_comparison(comparison_design(margin = 0.02, bounds = c(0, 1)))
comparison_report(state)

seqbench documentation built on Oct. 8, 2026, 5:07 p.m.