crmPack1.0.6 package

Object-Oriented Implementation of CRM Designs

DualEndpointOld-class

Dual endpoint model

LogisticIndepBeta-class

No initialization function Standard logistic model with prior in form ...

LogisticIndepBeta

Intialization function for "LogisticIndepBeta" class

matchTolerance

Helper function for value matching with tolerance

or-Stopping-StoppingAny

The method combining a stopping list and an atomic

or-StoppingAny-Stopping

The method combining an atomic and a stopping list

pinvGamma

Compute the distribution function of Inverse gamma distribution

plot-Data-missing-method

Plot method for the "Data" class

StoppingCohortsNearDose-class

Stop based on number of cohorts near to next best dose

StoppingCohortsNearDose

Initialization function for "StoppingCohortsNearDose"

StoppingPatientsNearDose-class

Stop based on number of patients near to next best dose

StoppingPatientsNearDose

Initialization function for "StoppingPatientsNearDose"

StoppingTargetBiomarker-class

Stop based on probability of target biomarker

StoppingTargetBiomarker

Initialization function for "StoppingTargetBiomarker"

StoppingTargetProb-class

Stop based on probability of target tox interval

StoppingTargetProb

Initialization function for "StoppingTargetProb"

update-DataParts-method

Update method for the "DataParts" class

is.probability

Predicate checking for a probability

is.probRange

Predicate checking for a probability range

is.range

Predicate checking for a numeric range

is.scalar

Checking for scalar

is.wholenumber

checks for whole numbers (integers)

joinBodies

Helper function to join two function bodies

joinModels

Helper function to join two BUGS models

and-StoppingAll-Stopping-method

The method combining a stopping list and an atomic

CohortSizeMax

Initialization function for "CohortSizeMax"

AllModels-class

Class for All models This is a class where all models inherit.

and-Stopping-Stopping-method

The method combining two atomic stopping rules

and-Stopping-StoppingAll-method

The method combining an atomic and a stopping list

DataDual

Initialization function for the "DataDual" class

approximate

Approximate posterior with (log) normal distribution

as.list-GeneralData-method

as.list method for the "GeneralData" class

biomLevel

Compute the biomarker level for a given dose, given model and samples

CohortSize-class

The virtual class for cohort sizes

CohortSizeConst-class

Constant cohort size

CohortSizeConst

Initialization function for "CohortSizeConst"

CohortSizeDLT-class

Cohort size based on number of DLTs

CohortSizeDLT

Initialization function for "CohortSizeDLT"

CohortSizeMax-class

Size based on maximum of multiple cohort size rules

CohortSizeMin-class

Size based on minimum of multiple cohort size rules

CohortSizeMin

Initialization function for "CohortSizeMin"

CohortSizeParts-class

Cohort size based on the parts

CohortSizeParts

Initialization function for "CohortSizeParts"

CohortSizeRange-class

Cohort size based on dose range

CohortSizeRange

Initialization function for "CohortSizeRange"

crmPack-package

Object-oriented implementation of CRM designs

crmPackExample

Open the example pdf for crmPack

crmPackHelp

Open the browser with help pages for crmPack

Data-class

Class for the data input

Data

Initialization function for the "Data" class

DataDual-class

Class for the dual endpoint data input

DataMixture-class

Class for the data with mixture sharing

DataMixture

Initialization function for the "DataMixture" class

DataParts-class

Class for the data with two study parts

DataParts

Initialization function for the "DataParts" class

Design-class

Class for the CRM design

Design

Initialization function for "Design"

dinvGamma

Compute the density of Inverse gamma distribution

dose

Compute the doses for a given probability, given model and samples

DualSimulations

Initialization function for "DualSimulations"

DualDesign-class

Class for the dual-endpoint CRM design

DualDesign

Initialization function for "DualDesign"

DualEndpoint-class

General class for the dual endpoint model

DualEndpoint

Initialization function for the "DualEndpoint" class

DualEndpointBeta-class

Dual endpoint model with beta function for dose-biomarker relationship

DualEndpointBeta

Initialization function for the "DualEndpointBeta" class

DualEndpointEmax-class

Dual endpoint model with emax function for dose-biomarker relationship

DualEndpointEmax

Initialization function for the "DualEndpointEmax" class

DualSimulationsSummary-class

Class for the summary of dual-endpoint simulations output

DualEndpointRW-class

Dual endpoint model with RW prior for biomarker

DualEndpointRW

Initialization function for the "DualEndpointRW" class

DualResponsesDesign-class

This is a class of design based on DLE responses using the `LogisticIn...

DualResponsesDesign

Initialization function for 'DualResponsesDesign"

DualResponsesSamplesDesign-class

This is a class of design based on DLE responses using the `LogisticIn...

DualResponsesSamplesDesign

Initialization function for 'DualResponsesSamplesDesign"

DualSimulations-class

Class for the simulations output from dual-endpoint model based design...

EffFlexi-class

Class for the efficacy model in flexible form for prior expressed in f...

EffFlexi

Initialization function for the "EffFlexi" class

Effloglog-class

Class for the linear log-log efficacy model using pseudo data prior

Effloglog

Initialization function for the "Effloglog" class

examine

Obtain hypothetical trial course table for a design

ExpEff

Compute the expected efficacy based on a given dose, a given pseudo Ef...

fit

Fit method for the Samples class

IncrementsNumDoseLevels

Initialization function for "IncrementsNumDoseLevels"

fitGain

Get the fiited values for the gain values at all dose levels based on ...

gain

Compute the gain value with a given dose level, given a pseudo DLE mod...

GeneralData-class

Class for general data input

GeneralModel-class

No Intitialization function for this General class for model input

GeneralSimulations-class

General class for the simulations output

GeneralSimulations

Initialization function for "GeneralSimulations"

GeneralSimulationsSummary-class

Class for the summary of general simulations output

get-Samples-character-method

Get specific parameter samples and produce a data.frame

getEff

Extracting efficacy responses for subjects without or with a DLE. This...

getMinInfBeta

Get the minimal informative unimodal beta distribution

getResultList

Helper function to obtain simulation results list

IncrementMin-class

Max increment based on minimum of multiple increment rules

IncrementMin

Initialization function for "IncrementMin"

Increments-class

The virtual class for controlling increments

IncrementsNumDoseLevels-class

Increments control based on number of dose levels

IncrementsRelative-class

Increments control based on relative differences in intervals

IncrementsRelative

Initialization function for "IncrementsRelative"

IncrementsRelativeDLT-class

Increments control based on relative differences in terms of DLTs

IncrementsRelativeDLT

Initialization function for "IncrementsRelativeDLT"

IncrementsRelativeParts-class

Increments control based on relative differences in intervals, with sp...

IncrementsRelativeParts

Initialization function for "IncrementsRelativeParts"

initialize-DualEndpointOld-method

Initialization method for the "DualEndpointOld" class

is.bool

Predicate checking for a boolean option

LogisticKadane-class

Reparametrized logistic model

LogisticKadane

Initialization function for the "LogisticKadane" class

LogisticLogNormal-class

Standard logistic model with bivariate (log) normal prior

LogisticLogNormal

Initialization function for the "LogisticLogNormal" class

LogisticLogNormalMixture-class

Standard logistic model with online mixture of two bivariate log norma...

LogisticLogNormalMixture

Initialization function for the "LogisticLogNormalMixture" class

LogisticLogNormalSub-class

Standard logistic model with bivariate (log) normal prior with substra...

LogisticLogNormalSub

Initialization function for the "LogisticLogNormalSub" class

LogisticNormal-class

Standard logistic model with bivariate normal prior

LogisticNormal

Initialization function for the "LogisticNormal" class

LogisticNormalFixedMixture-class

Standard logistic model with fixed mixture of multiple bivariate (log)...

LogisticNormalFixedMixture

Initialization function for the "LogisticNormalFixedMixture" class

LogisticNormalMixture-class

Standard logistic model with flexible mixture of two bivariate normal ...

LogisticNormalMixture

Initialization function for the "LogisticNormalMixture" class

logit

Shorthand for logit function

or-Stopping-Stopping

The method combining two atomic stopping rules

maxDose

Determine the maximum possible next dose

maxSize

"MAX" combination of cohort size rules

mcmc

Obtain posterior samples for all model parameters

McmcOptions-class

Class for the three canonical MCMC options

McmcOptions

Initialization function for the "McmcOptions" class

MinimalInformative

Construct a minimally informative prior

minSize

"MIN" combination of cohort size rules

Model-class

Class for the model input

ModelEff-class

No Initialization function class for Efficacy models using pseudo data...

ModelPseudo-class

Class of models using expressing their prior in form of Pseudo data

ModelTox-class

No intialization function Class for DLE models using pseudo data prior...

multiplot

Multiple plot function

myBarplot

Convenience function to make barplots of percentages

myBayesLogit

Do MCMC sampling for Bayesian logistic regression model

NextBest-class

The virtual class for finding next best dose

nextBest

Find the next best dose

NextBestMTD-class

The class with the input for finding the next best MTD estimate

NextBestDualEndpoint-class

The class with the input for finding the next dose based on the dual e...

NextBestDualEndpoint

Initialization function for "NextBestDualEndpoint"

NextBestMaxGain-class

Next best dose with maximum gain value based on a pseudo DLE and effic...

NextBestMaxGain

Initialization function for the class 'NextBestMaxGain'

NextBestMaxGainSamples-class

Next best dose with maximum gain value based on a pseudo DLE and effic...

NextBestMaxGainSamples

Initialization function for class "NextBestMaxGainSamples"

NextBestMTD

Initialization function for class "NextBestMTD"

NextBestNCRM-class

The class with the input for finding the next dose in target interval

NextBestNCRM

Initialization function for "NextBestNCRM"

NextBestTD-class

Next best dose based on Pseudo DLE model without sample

NextBestTD

Initialization function for the class "NextBestTD"

NextBestTDsamples-class

Next best dose based on Pseudo DLE Model with samples

NextBestTDsamples

Initialization function for class "NextBestTDsamples"

NextBestThreePlusThree-class

The class with the input for finding the next dose in target interval

NextBestThreePlusThree

Initialization function for "NextBestThreePlusThree"

noOverlap

Check overlap of two character vectors

plot-Data-ModelTox-method

Plot of the fitted dose-tox based with a given pseudo DLE model and da...

plot-DataDual-missing-method

Plot method for the "DataDual" class

plot-DataDual-ModelEff-method

Plot of the fitted dose-efficacy based with a given pseudo efficacy mo...

plot-DualSimulations-missing-method

Plot dual-endpoint simulations

plot-DualSimulationsSummary-missing-method

Plot summaries of the dual-endpoint design simulations

plot-GeneralSimulations-missing-method

Plot simulations

qinvGamma

Compute the quantile function of Inverse gamma distribution

plot-GeneralSimulationsSummary-missing-method

Graphical display of the general simulation summary

plot-PseudoDualFlexiSimulations-missing-method

Plot for PseudoDualFlexiSimulations

plot-PseudoDualSimulations-missing-method

Plot simulations

plot-PseudoDualSimulationsSummary-missing-method

Plot the summary of Pseudo Dual Simulations summary

plot-PseudoSimulationsSummary-missing-method

Plot summaries of the pseudo simulations

plot-Samples-DualEndpoint-method

Plotting dose-toxicity and dose-biomarker model fits

plot-Samples-Model-method

Plotting dose-toxicity model fits

PseudoSimulationsSummary-class

Class for the summary of pseudo-models simulations output

plot-Samples-ModelEff-method

Plot the fitted dose-effcacy curve using a model from ModelEff class...

plot-Samples-ModelTox-method

Plot the fitted dose-DLE curve using a ModelTox class model with sam...

plot-SimulationsSummary-missing-method

Plot summaries of the model-based design simulations

plot.gtable

Plots gtable objects

plotDualResponses

Plot of the DLE and efficacy curve side by side given a DLE pseudo mod...

plotGain

Plot the gain curve in addition with the dose-DLE and dose-efficacy cu...

printVignette

Taken from utils package (print.vignette)

prob

Compute the probability for a given dose, given model and samples

probit

Shorthand for probit function

ProbitLogNormal-class

Probit model with bivariate log normal prior

ProbitLogNormal

Initialization function for the "ProbitLogNormal" class

PseudoDualFlexiSimulations-class

This is a class which captures the trial simulations design using both...

PseudoDualFlexiSimulations

Initialization function for 'PseudoDualFlexiSimulations' class

PseudoDualSimulations-class

This is a class which captures the trial simulations design using both...

PseudoDualSimulations

Initialization function for 'DualPseudoSimulations' class

PseudoDualSimulationsSummary-class

Class for the summary of the dual responses simulations using pseudo m...

PseudoSimulations-class

This is a class which captures the trial simulations from designs usin...

PseudoSimulations

Initialization function of the 'PseudoSimulations' class

StoppingMTDdistribution

Initialization function for "StoppingMTDdistribution"

Quantiles2LogisticNormal

Convert prior quantiles (lower, median, upper) to logistic (log) norma...

Report

A Reference Class to represent sequentially updated reporting objects.

rinvGamma

The random generation of the Inverse gamma distribution

RuleDesign-class

Class for rule-based designs

RuleDesign

Initialization function for "RuleDesign"

safeInteger

Safe conversion to integer vector

Samples-class

Class for the MCMC output

Samples

Initialization function for "Samples"

sampleSize

Compute the number of samples for a given MCMC options triple

saveSample

Determine if we should save this sample

setSeed

Helper function to set and save the RNG seed

show-DualSimulationsSummary-method

Show the summary of the dual-endpoint simulations

show-GeneralSimulationsSummary-method

Show the summary of the simulations

show-PseudoDualSimulationsSummary-method

Show the summary of Pseudo Dual simulations summary

show-PseudoSimulationsSummary-method

Show the summary of the simulations

show-SimulationsSummary-method

Show the summary of the simulations

simulate-Design-method

Simulate outcomes from a CRM design

simulate-DualDesign-method

Simulate outcomes from a dual-endpoint design

simulate-DualResponsesDesign-method

This is a methods to simulate dose escalation procedure using both DLE...

simulate-DualResponsesSamplesDesign-method

This is a methods to simulate dose escalation procedure using both DLE...

simulate-RuleDesign-method

Simulate outcomes from a rule-based design

simulate-TDDesign-method

This is a methods to simulate dose escalation procedure only using the...

simulate-TDsamplesDesign-method

This is a methods to simulate dose escalation procedure only using the...

Simulations-class

Class for the simulations output from model based designs

Simulations

Initialization function for the "Simulations" class

SimulationsSummary-class

Class for the summary of model-based simulations output

size

Determine the size of the next cohort

Stopping-class

The virtual class for stopping rules

StoppingAll-class

Stop based on fullfillment of all multiple stopping rules

StoppingAll

Initialization function for "StoppingAll"

StoppingAny-class

Stop based on fullfillment of any stopping rule

StoppingAny

Initialization function for "StoppingAny"

StoppingGstarCIRatio-class

Stop based on a target ratio, the ratio of the upper to the lower 95% ...

StoppingGstarCIRatio

Initialization function for "StoppingGstarCIRatio"

StoppingHighestDose-class

Stop when the highest dose is reached

StoppingHighestDose

Initialization function for "StoppingHighestDose"

StoppingList-class

Stop based on multiple stopping rules

StoppingList

Initialization function for "StoppingList"

StoppingMinCohorts-class

Stop based on minimum number of cohorts

StoppingMinCohorts

Initialization function for "StoppingMinCohorts"

StoppingMinPatients-class

Stop based on minimum number of patients

StoppingMinPatients

Initialization function for "StoppingMinPatients"

StoppingMTDdistribution-class

Stop based on MTD distribution

StoppingTDCIRatio-class

Stop based on a target ratio, the ratio of the upper to the lower 95% ...

StoppingTDCIRatio

Initialization function for "StoppingTDCIRatio"

stopTrial

Stop the trial?

summary-DualSimulations-method

Summarize the dual-endpoint design simulations, relative to given true...

summary-GeneralSimulations-method

Summarize the simulations, relative to a given truth

summary-PseudoDualFlexiSimulations-method

Summary for Pseudo Dual responses simulations given a pseudo DLE model...

summary-PseudoDualSimulations-method

Summary for Pseudo Dual responses simulations, relative to a given pse...

summary-PseudoSimulations-method

Summarize the simulations, relative to a given truth

summary-Simulations-method

Summarize the model-based design simulations, relative to a given trut...

TDDesign-class

Design class using DLE responses only based on the pseudo DLE model wi...

TDDesign

Initialization function for 'TDDesign' class

TDsamplesDesign-class

This is a class of design based only on DLE responses using the 'Logis...

TDsamplesDesign

Initialization function for 'TDsamplesDesign' class

ThreePlusThreeDesign

Creates a new 3+3 design object from a dose grid

update-Data-method

Update method for the "Data" class

update-DataDual-method

Update method for the "DataDual" class

update-EffFlexi-method

Update method for the 'EffFlexi' Model class. This is a method to upda...

update-Effloglog-method

Update method for the 'Effloglog' Model class. This is a method to upd...

update-LogisticIndepBeta-method

Update method for the 'LogisticIndepBeta'Model class. This is a method...

Validate

A Reference Class to help programming validation for new S4 classes

writeModel

Creating a WinBUGS model file

Implements a wide range of model-based dose escalation designs, ranging from classical and modern continual reassessment methods (CRMs) based on dose-limiting toxicity endpoints to dual-endpoint designs taking into account a biomarker/efficacy outcome. The focus is on Bayesian inference, making it very easy to setup a new design with its own JAGS code. However, it is also possible to implement 3+3 designs for comparison or models with non-Bayesian estimation. The whole package is written in a modular form in the S4 class system, making it very flexible for adaptation to new models, escalation or stopping rules.

  • Maintainer: Daniel Sabanes Bove
  • License: GPL (>= 2)
  • Last published: 2024-06-26