report_confirm: A Methods Paragraph For a Discover-Then-Confirm Analysis

View source: R/confirm.R

report_confirmR Documentation

A Methods Paragraph For a Discover-Then-Confirm Analysis

Description

Generates a paragraph describing a discover-then-confirm analysis in the form usually required by a methods section: how the sample was divided, how each half was imputed, the tree that was discovered, and which of its splits survived testing on the confirmation data.

Usage

report_confirm(object, tree = NULL, digits = 3)

Arguments

object

A ctreeMI_dc object from discover_confirm(), or a ctreeMI_confirm object from confirm_ctreeMI().

tree

The discovery tree, required when object is a ctreeMI_confirm object and ignored otherwise.

digits

Number of digits used in the reported quantities.

Value

An object of class "ctreeMI_report", as returned by report_ctreeMI(): a list whose text element is the paragraph.

See Also

discover_confirm(), report_ctreeMI()

Examples

## Not run: 
res <- discover_confirm(y ~ ., data = d, m = 30, seed = 1)
report_confirm(res)

## End(Not run)

ctreeMI documentation built on Oct. 12, 2026, 5:08 p.m.