summarize_results: Summarize results

View source: R/summary_functs.R

summarize_resultsR Documentation

Summarize results

Description

Summarizes the results of a simulatr simulation.

Usage

summarize_results(sim_spec, sim_res, metrics, parameters, threshold = 0.05)

Arguments

sim_spec

a simulatr_specifier object

sim_res

the data frame of raw results, as outputted by simulatr

metrics

character vector of metrics to compute; options include "coverage," "bias," "se" (standard deviation of estimator), "mse", "rejection_probability," "count," and "time."

parameters

character vector of parameters on which to compute the metrics

threshold

(optional; default value 0.05) the rejection threshold to use for "rejection_probability" metric.

Value

a data frame of summarized results


timothy-barry/simulatr documentation built on Sept. 6, 2024, 7:10 p.m.