print.bucss_plan: Print a Bias and Uncertainty Corrected Sample Size Result

View source: R/bucss-internal.R

print.bucss_planR Documentation

Print a Bias and Uncertainty Corrected Sample Size Result

Description

Prints the aligned term/value table (the planned-study results followed by the rows echoing the planning inputs), then factual footer lines naming the design, for the regression planners the predictor frame (random_predictors), the unit the sample size is counted in, and the largest assurance the prior result can support. Whole numbers print clean; other values print at getOption("bucss.digits", 3) significant figures, except that a value below 1 is never shown as 1: it is given as many more figures as it takes to stay below 1 (a power of .99957 prints as 0.9996). Only the display is rounded; the stored values keep full precision.

Usage

## S3 method for class 'bucss_plan'
print(x, digits = getOption("bucss.digits", 3L), ...)

Arguments

x

An object of class bucss_plan.

digits

Significant figures for non-integer values; defaults to getOption("bucss.digits", 3).

...

Further arguments, ignored.

Value

x, invisibly.

Examples

result <- ss_buc_independent_t(t_observed = 3, n = c(50, 55),
  assurance = .90)
result

# Display only: the stored values keep full precision.
print(result, digits = 6)
result$value[result$term == "ncp_adjusted"]


BUCSS documentation built on Oct. 14, 2026, 1:07 a.m.