plot_metrics_ecdf {adaptr} | R Documentation |
Plot empirical cumulative distribution functions of performance metrics
Description
Plots empirical cumulative distribution functions (ECDFs) of numerical
performance metrics across multiple simulations from a "trial_results"
object returned by run_trials()
. Requires the ggplot2
package installed.
Usage
plot_metrics_ecdf(
object,
metrics = c("size", "sum_ys", "ratio_ys"),
restrict = NULL,
nrow = NULL,
ncol = NULL,
cores = NULL
)
Arguments
object |
|
metrics |
the performance metrics to plot, as described in
|
restrict |
single character string or |
nrow , ncol |
the number of rows and columns when plotting multiple
metrics in the same plot (using faceting in |
cores |
|
Value
A ggplot2
plot object.
See Also
check_performance()
, summary()
, extract_results()
,
plot_convergence()
, check_remaining_arms()
.
Examples
#### Only run examples if ggplot2 is installed ####
if (requireNamespace("ggplot2", quietly = TRUE)){
# Setup a trial specification
binom_trial <- setup_trial_binom(arms = c("A", "B", "C", "D"),
control = "A",
true_ys = c(0.20, 0.18, 0.22, 0.24),
data_looks = 1:20 * 100)
# Run multiple simulation with a fixed random base seed
res_mult <- run_trials(binom_trial, n_rep = 25, base_seed = 678)
# NOTE: the number of simulations in this example is smaller than
# recommended - the plots reflect that, and would likely be smoother if
# a larger number of trials had been simulated
# Plot ECDFs of continuous performance metrics
plot_metrics_ecdf(res_mult)
}