simulator: S4 Simulator Class Object

In tpq/rarsim: Response-Adaptive Randomization Simulation Station

Description

S4 Simulator Class Object

Usage

## S4 method for signature 'simulator'
show(object)

getPool(simulator)

getDraw(simulator)

simulator.start(pool)

simulator.start.from.norm(means, variances, N = 1000)

simulator.start.from.unif(mins, maxes, N = 1000)

simulator.draw(simulator, allocation)

Arguments

object, simulator	A simulator object.
pool	A list of vectors for all rewards available.
means	A vector of average rewards, one for each group.
variances	A vector of reward variances, one for each group.
N	An integer. The size of each group within the pool.
mins	A vector of minimums, one for each group.
maxes	A vector of maximums, one for each group.
allocation	A vector of groups to which to allocate new patients.

Slots

pool

A list of vectors for all rewards available.

meta

A list of tables for all rewards and meta-data available. This is optional, but may be preferred for complex simulations.

draw

The data most recently sampled from the pool.

Methods

show: Method to show simulator object.

Getters

getPool: Method to retrieve the data pool from a simulator object. This function returns a list of vectors for all rewards available.

getDraw: Method to retrieve the previous draw from a simulator object. This function returns the data most recently sampled from the pool.

Setters

simulator.start: Method to initialize a simulator object. This function returns a simulator object.

simulator.start.from.norm: Method to initialize a simulator object. This function returns a simulator object.

simulator.start.from.unif: Method to initialize a simulator object. This function returns a simulator object.

simulator.draw: Method to draw data from a simulator object. This function returns a simulator object.

tpq/rarsim documentation built on April 4, 2020, 3:49 a.m.