print.bifrost_simulation_template: Print method for bifrost simulation templates

View source: R/simulation-methods.R

print.bifrost_simulation_templateR Documentation

Print method for bifrost simulation templates

Description

Print a compact summary of a bifrost_simulation_template, including the aligned tree size, response/predictor structure, global calibration formula, downstream simulation-search formula, and the empirical covariance summaries used to generate simulation replicates.

Usage

## S3 method for class 'bifrost_simulation_template'
print(x, ...)

Arguments

x

A bifrost_simulation_template object returned by createSimulationTemplate().

...

Unused (S3 compatibility).

Value

Invisibly returns x. Called for its printing side effects.

See Also

createSimulationTemplate()

Examples

set.seed(1)
tr <- ape::rtree(12)
X <- matrix(rnorm(12 * 2), ncol = 2)
rownames(X) <- tr$tip.label
tmpl <- createSimulationTemplate(tr, X, formula = "trait_data ~ 1", method = "LL")
tmpl


bifrost documentation built on Nov. 5, 2026, 9:07 a.m.