Model-class: Class for the model input

In crmPack: Object-Oriented Implementation of CRM Designs

Class for the model input

Description

This is the model class for single agent dose escalation, from which all other specific models inherit. It inherits all slots from GeneralModel.

Details

The datamodel must obey the convention that the data input is called exactly as in the Data class. All prior distributions for parameters should be contained in the model function priormodel. The background is that this can be used to simulate from the prior distribution, before obtaining any data.

The dose function has as first argument prob, a scalar toxicity probability which is targeted. Additional arguments are model parameters. Then it computes, using model parameter(s) (samples), the resulting dose. Note that the model parameters are called exactly as in the model and must be included in the sample vector. The vectors of all samples for these parameters will then be supplied to the function. So your function must be able to process vectors of the model parameters, i.e. it must vectorize over them.

The prob function has as first argument dose, which is a scalar dose. Additional arguments are model parameters. Then it computes, using model parameter(s) (samples), the resulting probability of toxicity at that dose. Again here, the function must vectorize over the model parameters.

If you work with multivariate parameters, then please assume that your the two functions receive either one parameter value as a row vector, or a samples matrix where the rows correspond to the sampling index, i.e. the layout is then nSamples x dimParameter.

Note that dose and prob are the inverse functions of each other.

Slots

dose

a function computing the dose reaching a specific target probability, based on the model parameters and additional prior settings (see the details above)

prob

a function computing the probability of toxicity for a specific dose, based on the model parameters and additional prior settings (see the details above)

See Also

LogisticNormal, LogisticLogNormal, LogisticLogNormalSub, LogisticKadane, DualEndpoint

crmPack documentation built on June 26, 2024, 5:07 p.m.