Man pages for Roche/crmPack
Object-Oriented Implementation of CRM Designs

and-StoppingAll-Stopping-methodThe method combining a stopping list and an atomic
and-Stopping-StoppingAll-methodThe method combining an atomic and a stopping list
and-Stopping-Stopping-methodThe method combining two atomic stopping rules
approximateApproximate posterior with (log) normal distribution
assertionsAdditional Assertions for 'checkmate'
biomarkerGet the Biomarker Levels for a Given Dual-Endpoint Model,...
check_equalCheck if All Arguments Are Equal
check_formatCheck that an argument is a valid format specification
check_lengthCheck if vectors are of compatible lengths
check_probabilitiesCheck if an argument is a probability vector
check_probabilityCheck if an argument is a single probability value
check_probability_rangeCheck if an argument is a probability range
check_rangeCheck that an argument is a numerical range
CohortSize-class'CohortSize'
CohortSizeConst-class'CohortSizeConst'
CohortSizeDLT-class'CohortSizeDLT'
CohortSizeMax-class'CohortSizeMax'
CohortSizeMin-class'CohortSizeMin'
CohortSizeOrdinal-class'CohortSizeOrdinal'
CohortSizeParts-class'CohortSizeParts'
CohortSizeRange-class'CohortSizeRange'
CrmPackClass'CrmPackClass'
crmPackExampleOpen the example pdf for crmPack
crmPackHelpOpen the browser with help pages for crmPack
crmPack-packageObject-oriented implementation of CRM designs
DADesign-class'DADesign'
DALogisticLogNormal-class'DALogisticLogNormal'
dapplyApply a Function to Subsets of Data Frame.
DASimulationsInitialization function for 'DASimulations'
DASimulations-classClass for the simulations output from DA based designs
Data-class'Data'
DataDA-class'DataDA'
DataDual-class'DataDual'
DataGrouped-class'DataGrouped'
DataMixture-class'DataMixture'
DataOrdinal-class'DataOrdinal'
DataParts-class'DataParts'
Design-class'Design'
DesignGrouped-class'DesignGrouped'
DesignOrdinal-class'DesignOrdinal'
dinvGammaCompute the density of Inverse gamma distribution
DLTLikelihoodLikelihood of DLTs in each interval
doseComputing the Doses for a given independent variable, Model...
doseFunctionGetting the Dose Function for a Given Model Type
dose_grid_rangeGetting the Dose Grid Range
DualDesign-class'DualDesign'
DualEndpointBeta-class'DualEndpointBeta'
DualEndpoint-class'DualEndpoint'
DualEndpointEmax-class'DualEndpointEmax'
DualEndpointRW-class'DualEndpointRW'
DualResponsesDesign-class'DualResponsesDesign.R'
DualResponsesSamplesDesign-class'DualResponsesSamplesDesign'
DualSimulations-class'DualSimulations'
DualSimulationsSummary-class'DualSimulationsSummary'
EffFlexi-class'EffFlexi'
efficacyComputing Expected Efficacy for a Given Dose, Model and...
efficacyFunctionGetting the Efficacy Function for a Given Model Type
Effloglog-class'Effloglog'
enable_loggingVerbose Logging
examineObtain hypothetical trial course table for a design
fitFit method for the Samples class
fitGainGet the fitted values for the gain values at all dose levels...
fitPEMGet the fitted DLT free survival (piecewise exponential...
FractionalCRM-class'FractionalCRM'
gainCompute Gain Values based on Pseudo DLE and a Pseudo Efficacy...
GeneralData-class'GeneralData'
GeneralModel-class'GeneralModel'
GeneralSimulations-class'GeneralSimulations'
GeneralSimulationsSummary-class'GeneralSimulationsSummary'
getEffExtracting Efficacy Responses for Subjects Categorized by the...
get_result_listHelper Function to Obtain Simulation Results List
get-Samples-character-methodGet specific parameter samples and produce a data.frame
h_all_equivalentComparison with Numerical Tolerance and Without Name...
h_barplot_percentagesConvenience function to make barplots of percentages
h_blind_plot_dataHelper Function to Blind Plot Data
h_calc_report_label_percentageHelper function to calculate percentage of true stopping...
h_check_fun_formalsChecking Formals of a Function
h_convert_ordinal_dataConvert a Ordinal Data to the Equivalent Binary Data for a...
h_convert_ordinal_modelConvert an ordinal CRM model to the Equivalent Binary CRM...
h_convert_ordinal_samplesConvert a Samples Object from an ordinal Model to the...
h_covr_helpersHelpers for stripping expressions of 'covr'-inserted trace...
h_default_if_emptyGetting the default value for an empty object
h_determine_dltsHelper function to determine the dlts including first...
h_find_intervalFind Interval Numbers or Indices and Return Custom Number For...
h_format_numberConditional Formatting Using C-style Formats
h_get_formatted_dosegridFormat a 'doseGrid' for Printing
h_get_min_inf_betaHelper for Minimal Informative Unimodal Beta Distribution
h_group_dataGroup Together Mono and Combo Data
h_info_theory_distCalculating the Information Theoretic Distance
h_in_rangeCheck which elements are in a given range
h_is_positive_definiteTesting Matrix for Positive Definiteness
h_jags_add_dummyAppending a Dummy Number for Selected Slots in Data
h_jags_extract_samplesExtracting Samples from 'JAGS' 'mcarray' Object
h_jags_get_dataGetting Data for 'JAGS'
h_jags_get_model_initsSetting Initial Values for 'JAGS' Model Parameters
h_jags_join_modelsJoining 'JAGS' Models
h_jags_write_modelWriting JAGS Model to a File
h_model_dual_endpoint_betaUpdate certain components of 'DualEndpoint' model with regard...
h_model_dual_endpoint_rhoUpdate 'DualEndpoint' class model components with regard to...
h_model_dual_endpoint_sigma2betaWUpdate certain components of 'DualEndpoint' model with regard...
h_model_dual_endpoint_sigma2WUpdate 'DualEndpoint' class model components with regard to...
h_next_best_eligible_dosesGet Eligible Doses from the Dose Grid.
h_next_best_mg_ciCredibility Intervals for Max Gain and Target Doses at...
h_next_best_mg_doses_at_gridGet Closest Grid Doses for a Given Target Doses for...
h_next_best_mg_plotBuilding the Plot for 'nextBest-NextBestMaxGain' Method.
h_next_best_mgsamples_plotBuilding the Plot for 'nextBest-NextBestMaxGainSamples'...
h_next_best_ncrm_loss_plotBuilding the Plot for 'nextBest-NextBestNCRMLoss' Method.
h_next_best_td_plotBuilding the Plot for 'nextBest-NextBestTD' Method.
h_next_best_tdsamples_plotBuilding the Plot for 'nextBest-NextBestTDsamples' Method.
h_null_if_naGetting 'NULL' for 'NA'
h_obtain_dose_grid_rangeHelper Function Containing Common Functionality
h_plot_data_cohort_linesPreparing Cohort Lines for Data Plot
h_plot_data_dfPreparing Data for Plotting
h_rapplyRecursively Apply a Function to a List
h_simulations_output_formatHelper Function to create return list for Simulations output
h_slotsGetting the Slots from a S4 Object
h_summarize_add_statsHelper function to calculate average across iterations for...
h_test_named_numericCheck that an argument is a named vector of type numeric
h_this_truthHelper Function to call truth calculation
h_unpack_stopitHelper function to recursively unpack stopping rules and...
h_validate_combine_resultsCombining S4 Class Validation Results
h_validate_common_data_slotsHelper Function performing validation Common to Data and...
Increments-class'Increments'
IncrementsDoseLevels-class'IncrementsDoseLevels'
IncrementsHSRBeta-class'IncrementsHSRBeta'
IncrementsMin-class'IncrementsMin'
IncrementsOrdinal-class'IncrementsOrdinal'
IncrementsRelative-class'IncrementsRelative'
IncrementsRelativeDLT-class'IncrementsRelativeDLT'
IncrementsRelativeDLTCurrent-class'IncrementsRelativeDLTCurrent'
IncrementsRelativeParts-class'IncrementsRelativeParts'
is.wholenumberchecks for whole numbers (integers)
knit_printRender a 'CohortSizeConst' Object
LogisticIndepBeta-class'LogisticIndepBeta'
LogisticKadaneBetaGamma-class'LogisticKadaneBetaGamma'
LogisticKadane-class'LogisticKadane'
LogisticLogNormal-class'LogisticLogNormal'
LogisticLogNormalGrouped-class'LogisticLogNormalGrouped'
LogisticLogNormalMixture-class'LogisticLogNormalMixture'
LogisticLogNormalOrdinal-class'LogisticLogNormalOrdinal'
LogisticLogNormalSub-class'LogisticLogNormalSub'
LogisticNormal-class'LogisticNormal'
LogisticNormalFixedMixture-class'LogisticNormalFixedMixture'
LogisticNormalMixture-class'LogisticNormalMixture'
logitShorthand for logit function
match_within_toleranceHelper function for value matching with tolerance
maxDoseDetermine the Maximum Possible Next Dose
maxSize"MAX" combination of cohort size rules
mcmcObtaining Posterior Samples for all Model Parameters
McmcOptions-class'McmcOptions'
MinimalInformativeConstruct a minimally informative prior
minSize"MIN" combination of cohort size rules
ModelEff-class'ModelEff'
ModelLogNormal-class'ModelLogNormal'
ModelParamsNormal-class'ModelParamsNormal'
ModelPseudo-class'ModelPseudo'
ModelTox-class'ModelTox'
myBayesLogitDo MCMC sampling for Bayesian logistic regression model
names-Samples-methodThe Names of the Sampled Parameters
nextBestFinding the Next Best Dose
NextBest-class'NextBest'
NextBestDualEndpoint-class'NextBestDualEndpoint'
NextBestInfTheory-class'NextBestInfTheory'
NextBestMaxGain-class'NextBestMaxGain'
NextBestMaxGainSamples-class'NextBestMaxGainSamples'
NextBestMinDist-class'NextBestMinDist'
NextBestMTD-class'NextBestMTD'
NextBestNCRM-class'NextBestNCRM'
NextBestNCRMLoss-class'NextBestNCRMLoss'
NextBestOrdinal-class'NextBestOrdinal'
NextBestProbMTDLTE-class'NextBestProbMTDLTE'
NextBestProbMTDMinDist-class'NextBestProbMTDMinDist'
NextBestTD-class'NextBestTD'
NextBestTDsamples-class'NextBestTDsamples'
NextBestThreePlusThree-class'NextBestThreePlusThree'
ngridNumber of Doses in Grid
OneParExpPrior-class'OneParExpPrior'
OneParLogNormalPrior-class'OneParLogNormalPrior'
or-StoppingAny-StoppingThe method combining an atomic and a stopping list
or-Stopping-StoppingThe method combining two atomic stopping rules
or-Stopping-StoppingAnyThe method combining a stopping list and an atomic
pinvGammaCompute the distribution function of Inverse gamma...
pipePipe operator
plot-DataHelper Function for the Plot Method of the Data and...
plot-DataDA-missing-methodPlot Method for the 'DataDA' Class
plot-DataDual-missing-methodPlot Method for the 'DataDual' Class
plot-DataDual-ModelEff-methodPlot of the fitted dose-efficacy based with a given pseudo...
plot-Data-ModelTox-methodPlot of the fitted dose-tox based with a given pseudo DLE...
plotDualResponsesPlot of the DLE and efficacy curve side by side given a DLE...
plot-DualSimulations-missing-methodPlot dual-endpoint simulations
plot-DualSimulationsSummary-missing-methodPlot summaries of the dual-endpoint design simulations
plotGainPlot the gain curve in addition with the dose-DLE and...
plot-GeneralSimulations-missing-methodPlot simulations
plot-GeneralSimulationsSummary-missing-methodGraphical display of the general simulation summary
plot.gtablePlot 'gtable' Objects
plot-PseudoDualFlexiSimulations-missing-methodThis plot method can be applied to...
plot-PseudoDualSimulations-missing-methodPlot simulations
plot-PseudoDualSimulationsSummary-missing-methodPlot the summary of Pseudo Dual Simulations summary
plot-PseudoSimulationsSummary-missing-methodPlot summaries of the pseudo simulations
plot-Samples-DALogisticLogNormal-methodPlotting dose-toxicity model fits
plot-Samples-DualEndpoint-methodPlotting dose-toxicity and dose-biomarker model fits
plot-Samples-GeneralModel-methodPlotting dose-toxicity model fits
plot-Samples-ModelEff-methodPlot the fitted dose-efficacy curve using a model from...
plot-Samples-ModelTox-methodPlot the fitted dose-DLE curve using a 'ModelTox' class model...
plot-SimulationsSummary-missing-methodPlot summaries of the model-based design simulations
positive_number'positive_number'
printVignetteTaken from utils package (print.vignette)
probComputing Toxicity Probabilities for a Given Dose, Model and...
probFunctionGetting the Prob Function for a Given Model Type
probitShorthand for probit function
ProbitLogNormal-class'ProbitLogNormal'
ProbitLogNormalRel-class'ProbitLogNormalRel'
PseudoDualFlexiSimulationsInitialization function for 'PseudoDualFlexiSimulations'...
PseudoDualFlexiSimulations-classThis is a class which captures the trial simulations design...
PseudoDualSimulationsInitialization function for 'DualPseudoSimulations' class
PseudoDualSimulations-classClass 'PseudoDualSimulations'
PseudoDualSimulationsSummary-classClass for the summary of the dual responses simulations using...
PseudoSimulations-class'PseudoSimulations'
PseudoSimulationsSummary-classClass for the summary of pseudo-models simulations output
qinvGammaCompute the quantile function of Inverse gamma distribution
Quantiles2LogisticNormalConvert prior quantiles (lower, median, upper) to logistic...
ReportA Reference Class to represent sequentially updated reporting...
rinvGammaThe random generation of the Inverse gamma distribution
RuleDesign-class'RuleDesign'
RuleDesignOrdinal-class'RuleDesignOrdinal'
safeIntegerSafe conversion to integer vector
SafetyWindow-class'SafetyWindow'
SafetyWindowConst-class'SafetyWindowConst'
SafetyWindowSize-class'SafetyWindowSize'
Samples-class'Samples'
saveSampleDetermining if this Sample Should be Saved
set_seedHelper Function to Set and Save the RNG Seed
show-DualSimulationsSummary-methodShow the summary of the dual-endpoint simulations
show-GeneralSimulationsSummary-methodShow the summary of the simulations
show-PseudoDualSimulationsSummary-methodShow the summary of Pseudo Dual simulations summary
show-PseudoSimulationsSummary-methodShow the summary of the simulations
show-SimulationsSummary-methodShow the summary of the simulations
simulate-DADesign-methodSimulate outcomes from a time-to-DLT augmented CRM design...
simulate-DesignGrouped-methodSimulate Method for the 'DesignGrouped' Class
simulate-Design-methodSimulate outcomes from a CRM design
simulate-DualDesign-methodSimulate outcomes from a dual-endpoint design
simulate-DualResponsesDesign-methodThis is a methods to simulate dose escalation procedure using...
simulate-DualResponsesSamplesDesign-methodThis is a methods to simulate dose escalation procedure using...
simulate-RuleDesign-methodSimulate outcomes from a rule-based design
simulate-TDDesign-methodThis is a methods to simulate dose escalation procedure only...
simulate-TDsamplesDesign-methodThis is a methods to simulate dose escalation procedure only...
Simulations-class'Simulations'
SimulationsSummary-class'SimulationsSummary'
sizeSize of an Object
StoppingAll-class'StoppingAll'
StoppingAny-class'StoppingAny'
Stopping-class'Stopping'
StoppingCohortsNearDose-class'StoppingCohortsNearDose'
StoppingExternal-class'StoppingExternal'
StoppingHighestDose-class'StoppingHighestDose'
StoppingList-class'StoppingList'
StoppingLowestDoseHSRBeta-class'StoppingLowestDoseHSRBeta'
StoppingMaxGainCIRatio-class'StoppingMaxGainCIRatio'
StoppingMinCohorts-class'StoppingMinCohorts'
StoppingMinPatients-class'StoppingMinPatients'
StoppingMissingDose-class'StoppingMissingDose'
StoppingMTDCV-class'StoppingMTDCV'
StoppingMTDdistribution-class'StoppingMTDdistribution'
StoppingOrdinal-class'StoppingOrdinal'
StoppingPatientsNearDose-class'StoppingPatientsNearDose'
StoppingSpecificDose-class'StoppingSpecificDose'
StoppingTargetBiomarker-class'StoppingTargetBiomarker'
StoppingTargetProb-class'StoppingTargetProb'
StoppingTDCIRatio-class'StoppingTDCIRatio'
stopTrialStop the trial?
summary-DualSimulations-methodSummarize the dual-endpoint design simulations, relative to...
summary-GeneralSimulations-methodSummarize the simulations, relative to a given truth
summary-PseudoDualFlexiSimulations-methodSummary for Pseudo Dual responses simulations given a pseudo...
summary-PseudoDualSimulations-methodSummary for Pseudo Dual responses simulations, relative to a...
summary-PseudoSimulations-methodSummarize the simulations, relative to a given truth
summary-Simulations-methodSummarize the model-based design simulations, relative to a...
TDDesign-class'TDDesign'
TDsamplesDesign-class'TDsamplesDesign'
tidyTidying 'CrmPackClass' objects
TITELogisticLogNormal-class'TITELogisticLogNormal'
update-DataDA-methodUpdating 'DataDA' Objects
update-DataDual-methodUpdating 'DataDual' Objects
update-Data-methodUpdating 'Data' Objects
update-DataOrdinal-methodUpdating 'DataOrdinal' Objects
update-DataParts-methodUpdating 'DataParts' Objects
update-ModelPseudo-methodUpdate method for the 'ModelPseudo' model class. This is a...
Validate'Validate'
v_cohort_sizeInternal Helper Functions for Validation of 'CohortSize'...
v_data_objectsInternal Helper Functions for Validation of 'GeneralData'...
v_designInternal Helper Functions for Validation of 'RuleDesign'...
v_general_simulationsInternal Helper Functions for Validation of...
v_incrementsInternal Helper Functions for Validation of 'Increments'...
v_mcmcoptions_objectsInternal Helper Functions for Validation of 'McmcOptions'...
v_model_objectsInternal Helper Functions for Validation of 'GeneralModel'...
v_model_paramsInternal Helper Functions for Validation of Model Parameters...
v_next_bestInternal Helper Functions for Validation of 'NextBest'...
v_pseudo_simulationsInternal Helper Functions for Validation of...
v_safety_windowInternal Helper Functions for Validation of 'SafetyWindow'...
v_samples_objectsInternal Helper Functions for Validation of 'Samples' Objects
v_stoppingInternal Helper Functions for Validation of 'Stopping'...
windowLengthDetermine the safety window length of the next cohort
Roche/crmPack documentation built on April 15, 2024, 8:06 a.m.