Skip to contents

Print method for bifrost simulation templates

Source: R/simulation-methods.R
print.bifrost_simulation_template.Rd

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 Simulation Template
#> ===========================
#> 
#> Tree
#>   Tips: 12
#>   Response traits: 2
#>   Predictor columns: 0
#> 
#> Model
#>   Calibration formula: trait_data ~ 1
#>   Simulation search:   trait_data ~ 1
#>   Method: LL
#> 
#> Empirical Covariance Summaries
#>   Variance mean: 0.836783
#>   Variance sd:   0.514230
#>   Covariance mean: 0.084261
#>   Covariance sd:   0.000000