Model-class: 'Model'

In 0liver0815/onc-crmpack-test: Object-Oriented Implementation of CRM Designs

Description

Model is the old class for single agent dose escalation, from which all other specific models inherit. The Model class inherits from GeneralModel. It will be soon removed as the dose and prob are moved to a separate S4 class-specific methods.

Details

The first argument of dose function must be the prob, which is a scalar toxicity probability which is targeted. Further arguments are the model parameters. The dose function computes, using model parameter(s) (samples), the resulting dose. 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. Hence, a user function must be able to handle vectorized model parameters.

The first argument of prob function must be the dose, which is a scalar dose. Further arguments are the model parameters. The prob function computes, using model parameter(s) (samples), the resulting probability of toxicity at that dose. Again here, the function should support vectorized model parameters.

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

If you work with multivariate parameters, then assume that your 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.

Slots

dose

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

prob

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

Note

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.

0liver0815/onc-crmpack-test documentation built on Feb. 19, 2022, 12:25 a.m.