print.bifrost_simulation_study: Print method for bifrost simulation studies

In bifrost: Branch-Level Inference Framework for Recognizing Optimal Shifts in Traits

Print method for bifrost simulation studies

Description

Print a compact summary of a bifrost_simulation_study, including the study type, generating scenario, replicate counts, and the main false-positive or recovery summaries attached to the study object.

Usage

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

Arguments

x	A bifrost_simulation_study object returned by runFalsePositiveSimulationStudy() or runShiftRecoverySimulationStudy().
...	Unused (S3 compatibility).

Value

Invisibly returns x. Called for its printing side effects.

See Also

runFalsePositiveSimulationStudy(), runShiftRecoverySimulationStudy()

Examples

study <- structure(
  list(
    study_type = "false_positive",
    generating_scenario = "null",
    study_summary = list(
      n_replicates = 2L,
      n_completed = 2L,
      n_failed = 0L,
      mean_false_positive_rate = 0,
      median_false_positive_rate = 0
    )
  ),
  class = c("bifrost_simulation_study", "list")
)
study

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