Print method for bifrost simulation studies

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 Simulation Study
#> =======================
#> 
#> Study
#>   Type: false_positive
#>   Scenario: null
#>   Replicates: 2
#>   Completed: 2
#>   Failed: 0
#> 
#> False-Positive Summary
#>   Mean FP rate:   0.0000
#>   Median FP rate: 0.0000