Function reference • adaptr

Package overview

adaptr adaptr-package: adaptr: Adaptive Trial Simulator

Parallelisation

setup_cluster(): Setup default cluster for use in parallelised adaptr functions

Setup, calibrate, and run trials

setup_trial(): Setup a generic trial specification

setup_trial_binom(): Setup a trial specification using a binary, binomially distributed outcome

setup_trial_norm(): Setup a trial specification using a continuous, normally distributed outcome

calibrate_trial(): Calibrate trial specification

run_trial(): Simulate a single trial

run_trials(): Simulate multiple trials

Extract and summarise results

extract_results(): Extract simulation results

check_performance(): Check performance metrics for trial simulations

summary(<trial_results>): Summary of simulated trial results

check_remaining_arms(): Check remaining arm combinations

Plotting functions

plot_convergence(): Plot convergence of performance metrics

plot_metrics_ecdf(): Plot empirical cumulative distribution functions of performance metrics

plot_status(): Plot statuses

plot_history(): Plot trial metric history

Print methods

print(<trial_spec>) print(<trial_result>) print(<trial_performance>) print(<trial_results>) print(<trial_results_summary>) print(<trial_calibration>): Print methods for adaptive trial objects

Helper functions

update_saved_trials(): Update previously saved simulation results

update_saved_calibration(): Update previously saved calibration result

find_beta_params(): Find beta distribution parameters from thresholds