Learn R Programming

⚠️There's a newer version (4.2.0) of this package.Take me there.

rpact

Confirmatory Adaptive Clinical Trial Design, Simulation, and Analysis.

Functional Range

  • Sample size and power calculation for
    • means (continuous endpoint)
    • rates (binary endpoint)
    • survival trials with
      • piecewise accrual time and intensity
      • piecewise exponential survival time
      • survival times that follow a Weibull distribution
  • Fixed sample design and designs with interim analysis stages
  • Simulation tool for means, rates, and survival data
    • Assessment of adaptive sample size/event number recalculations based on conditional power
    • Assessment of treatment selection strategies in multi-arm trials
  • Adaptive analysis of means, rates, and survival data
  • Adaptive designs and analysis for multi-arm trials

Installation

Install the latest CRAN release via

install.packages("rpact")

Documentation

The documentation is hosted at https://www.rpact.org

Vignettes

The vignettes are hosted at https://www.rpact.org/vignettes

Use on corporate computer systems

Please contact us to learn how to use rpact on FDA/GxP-compliant validated corporate computer systems and how to get a copy of the formal validation documentation that is customized and licensed for exclusive use by your company, e.g., to fulfill regulatory requirements.

www.rpact.com/contact

About

  • rpact is a comprehensive validated[1] R package for clinical research which
    • enables the design and analysis of confirmatory adaptive group sequential designs
    • is a powerful sample size calculator
    • is a free of charge open-source software licensed under LGPL-3
    • particularly, implements the methods described in the recent monograph by Wassmer and Brannath (2016)

For more information please visit www.rpact.org

  • RPACT is a company which offers
    • enterprise software development services
    • technical support for the rpact package
    • consultancy and user training for clinical research using R
    • validated software solutions and R package development for clinical research

For more information please visit www.rpact.com

  1. The rpact validation documentation is available exclusively for our customers and supporting members. For more information visit www.rpact.com/services/sla

Copy Link

Version

Install

install.packages('rpact')

Monthly Downloads

1,194

Version

3.0.3

License

LGPL-3

Maintainer

Friedrich Pahlke

Last Published

December 1st, 2020

Functions in rpact (3.0.3)

AnalysisResultsMultiArmFisher

Analysis Results Multi-Arm Fisher
AnalysisResults_summary

Analysis Results Summary
AnalysisResults

Basic Class for Analysis Results
AccrualTime

Accrual Time
AnalysisResultsMultiArmGroupSequential

Analysis Results Multi-Arm Group Sequential
AnalysisResultsGroupSequential

Analysis Results Group Sequential
AnalysisResultsInverseNormal

Analysis Results Inverse Normal
AnalysisResultsConditionalDunnett

Analysis Results Multi-Arm Conditional Dunnett
AnalysisResultsMultiArmInverseNormal

Analysis Results Multi-Arm Inverse Normal
AnalysisResultsMultiArm

Basic Class for Analysis Results Multi-Arm
DatasetMeans

Dataset of Means
ConditionalPowerResults

Conditional Power Results
ClosedCombinationTestResults

Analysis Results Closed Combination Test
DatasetRates

Dataset of Rates
FieldSet_print

Print Field Set Values
AnalysisResultsFisher

Analysis Results Fisher
Dataset

Dataset
DatasetSurvival

Dataset of Survival Data
EventProbabilities

Event Probabilities
ParameterSet_as.data.frame

Coerce Parameter Set to a Data Frame
FrameSet_as.matrix

Coerce Frame Set to a Matrix
SimulationResultsRates

Class for Simulation Results Rates
SimulationResultsSurvival

Class for Simulation Results Survival
SimulationResultsMultiArmRates

Class for Simulation Results Multi-Arm Rates
ParameterSet_summary

Parameter Set Summary
AnalysisResults_as.data.frame

Coerce AnalysisResults to a Data Frame
PiecewiseSurvivalTime

Piecewise Exponential Survival Time
PlotSettings

Plot Settings
AnalysisResults_names

Names of a Analysis Results Object
StageResultsMeans

Stage Results of Means
PowerAndAverageSampleNumberResult

Power and Average Sample Number Result
ParameterSet_print

Print Parameter Set Values
NumberOfSubjects

Number Of Subjects
SimulationResultsMultiArmSurvival

Class for Simulation Results Multi-Arm Survival
TrialDesignCharacteristics

Trial Design Characteristics
SimulationResultsMeans

Class for Simulation Results Means
TrialDesign

Basic Trial Design
TrialDesignSet

Class for trial design sets.
TrialDesignSet_as.data.frame

Coerce Trial Design Set to a Data Frame
SimulationResultsMultiArmMeans

Class for Simulation Results Multi-Arm Means
StageResultsRates

Stage Results of Rates
TrialDesignPlanRates

Trial Design Plan Rates
ParameterSet

Parameter Set
TrialDesignPlanMeans

Trial Design Plan Means
getClosedConditionalDunnettTestResults

Get Closed Conditional Dunnett Test Results
SimulationResults

Class for Simulation Results
PowerAndAverageSampleNumberResult_as.data.frame

Coerce Power And Average Sample Number Result to a Data Frame
plotTypes

Get Available Plot Types
getClosedCombinationTestResults

Get Closed Combination Test Results
FieldSet

Field Set
TrialDesignCharacteristics_as.data.frame

Coerce TrialDesignCharacteristics to a Data Frame
getConditionalPower

Get Conditional Power
SimulationResults_names

Names of a Simulation Results Object
StageResults

Basic Stage Results
StageResults_names

Names of a Stage Results Object
getParameterCaption

Get Parameter Caption
TrialDesignInverseNormal

Inverse Normal Design
SummaryFactory

Summary Factory
getFinalConfidenceInterval

Get Final Confidence Interval
TrialDesignPlan_as.data.frame

Coerce Trial Design Plan to a Data Frame
getConditionalRejectionProbabilities

Get Conditional Rejection Probabilities
TrialDesignSet_names

Names of a Trial Design Set Object
TrialDesignPlan

Basic Trial Design Plan
TrialDesignPlanSurvival

Trial Design Plan Survival
TrialDesignConditionalDunnett

Conditional Dunnett Design
getDesignGroupSequential

Get Design Group Sequential
TrialDesignSet_length

Length of Trial Design Set
FieldSet_names

Names of a Field Set Object
getParameterName

Get Parameter Name
getData

Get Simulation Data
getRepeatedConfidenceIntervals

Get Repeated Confidence Intervals
getDesignSet

Get Design Set
getSimulationMultiArmSurvival

Get Simulation Multi-Arm Survival
getSimulationRates

Get Simulation Rates
getFinalPValue

Get Final P Value
param_allocationRatioPlanned_sampleSize

Parameter Description: Allocation Ratio Planned With Optimum Option
getSampleSizeSurvival

Get Sample Size Survival
getEventProbabilities

Get Event Probabilities
getSimulationMeans

Get Simulation Means
getSampleSizeRates

Get Sample Size Rates
getSampleSizeMeans

Get Sample Size Means
getRepeatedPValues

Get Repeated P Values
param_alternative

Parameter Description: Alternative
getDesignInverseNormal

Get Design Inverse Normal
getNumberOfSubjects

Get Number Of Subjects
param_alpha

Parameter Description: Alpha
param_conditionalPowerSimulation

Parameter Description: Conditional Power
getPowerSurvival

Get Power Survival
getOutputFormat

Get Output Format
StageResults_as.data.frame

Coerce Stage Results to a Data Frame
StageResultsSurvival

Stage Results of Survival Data
TrialDesignFisher

Fisher Design
getRawData

Get Simulation Raw Data for Survival
getTestActions

Get Test Actions
param_dropoutRate1

Parameter Description: Dropout Rate (1)
param_dataInput

Parameter Description: Data Input
param_eventTime

Parameter Description: Event Time
param_gED50

Parameter Description: G ED50
param_calcEventsFunction

Parameter Description: Calculate Events Function
param_kMax

Parameter Description: Maximum Number of Stages
param_bindingFutility

Parameter Description: Binding Futility
TrialDesignGroupSequential

Group Sequential Design
param_minNumberOfEventsPerStage

Parameter Description: Min Number Of Events Per Stage
param_accrualIntensity

Parameter Description: Accrual Intensity
param_plotPointsEnabled

Parameter Description: Plot Points Enabled
param_minNumberOfSubjectsPerStage

Parameter Description: Minimum Number Of Subjects Per Stage
param_kappa

Parameter Description: Kappa
param_dropoutRate2

Parameter Description: Dropout Rate (2)
param_median1

Parameter Description: Median (1)
TrialDesign_as.data.frame

Coerce TrialDesign to a Data Frame
getDesignConditionalDunnett

Get Design Conditional Dunnett Test
getAccrualTime

Get Accrual Time
getAnalysisResults

Get Analysis Results
getDesignFisher

Get Design Fisher
param_median2

Parameter Description: Median (2)
param_beta

Parameter Description: Beta
param_digits

Parameter Description: Digits
Trial_Design_Set_summary

Trial Design Set Summary
getDataset

Get Dataset
getPiecewiseSurvivalTime

Get Piecewise Survival Time
getPowerMeans

Get Power Means
getLogLevel

Get Log Level
getDesignCharacteristics

Get Design Characteristics
getLambdaStepFunction

Get Lambda Step Function
param_rValue

Parameter Description: RValue
getPowerAndAverageSampleNumber

Get Power And Average Sample Number
getSimulationSurvival

Get Simulation Survival
getStageResults

Get Stage Results
param_directionUpper

Parameter Description: Direction Upper
getPowerRates

Get Power Rates
param_hazardRatio

Parameter Description: Hazard Ratio
param_stDevSimulation

Parameter Description: Standard Deviation for Simulation
getSimulationMultiArmMeans

Get Simulation Multi-Arm Means
param_includeAllParameters

Parameter Description: Include All Parameters
param_niceColumnNamesEnabled

Parameter Description: Nice Column Names Enabled
param_maxNumberOfIterations

Parameter Description: Maximum Number Of Iterations
param_dropoutTime

Parameter Description: Dropout Time
param_maxNumberOfSubjects

Parameter Description: Maximum Number Of Subjects
getSimulationMultiArmRates

Get Simulation Multi-Arm Rates
param_stage

Parameter Description: Stage
param_effectMatrix

Parameter Description: Effect Matrix
param_activeArms

Parameter Description: Active Arms
param_accrualTime

Parameter Description: Accrual Time
param_adaptations

Parameter Description: Adaptations
param_design

Parameter Description: Design
param_allocationRatioPlanned

Parameter Description: Allocation Ratio Planned
param_plannedSubjects

Parameter Description: Planned Subjects
param_design_with_default

Parameter Description: Design with Default
param_plannedEvents

Parameter Description: Planned Events
param_typeOfComputation

Parameter Description: Type Of Computation
param_showStatistics

Parameter Description: ShowStatistics
param_showSource

Parameter Description: Show Source
param_tolerance

Parameter Description: Tolerance
param_normalApproximation

Parameter Description: Normal Approximation
plot.Dataset

Dataset Plotting
param_threshold

Parameter Description: Threshold
param_three_dots_plot

Parameter Description: "..." (optional plot arguments)
param_typeOfSelection

Parameter Description: Type of Selection
param_typeOfDesign

Parameter Description: Type of Design
param_palette

Parameter Description: Palette
param_legendPosition

Parameter Description: Legend Position On Plots
param_groups

Parameter Description: Number Of Treatment Groups
param_grid

Parameter Description: Grid (Output Specification Of Multiple Plots)
param_calcSubjectsFunction

Parameter Description: Calculate Subjects Function
param_maxNumberOfEventsPerStage

Parameter Description: Max Number Of Events Per Stage
param_conditionalPower

Parameter Description: Conditional Power
param_informationRates

Parameter Description: Information Rates
rpact

rpact - Confirmatory Adaptive Clinical Trial Design and Analysis
resetLogLevel

Reset Log Level
setLogLevel

Set Log Level
plot.TrialDesign

Trial Design Plotting
plot.EventProbabilities

Event Probabilities Plotting
plot.TrialDesignPlan

Trial Design Plan Plotting
param_intersectionTest

Parameter Description: Intersection Test
param_effectMeasure

Parameter Description: Effect Measure
param_epsilonValue

Parameter Description: EpsilonValue
setOutputFormat

Set Output Format
param_lambda1

Parameter Description: Lambda (1)
param_maxNumberOfSubjectsPerStage

Parameter Description: Maximum Number Of Subjects Per Stage
param_piecewiseSurvivalTime

Parameter Description: Piecewise Survival Time
param_pi2_survival

Parameter Description: Pi (2) for Survival Data
param_stageResults

Parameter Description: Stage Results
param_successCriterion

Parameter Description: Success Criterion
param_pi1_survival

Parameter Description: Pi (1) for Survival Data
plot.AnalysisResults

Analysis Results Plotting
[,TrialDesignSet-method

Access Trial Design by Index
param_varianceOption

Parameter Description: Variance Option
param_maxNumberOfSubjects_survival

Parameter Description: Maximum Number Of Subjects For Survival Endpoint
param_nMax

Parameter Description: N_max
param_sided

Parameter Description: Sided
param_pi2_rates

Parameter Description: Pi (2) for Rates
param_lambda2

Parameter Description: Lambda (2)
param_slope

Parameter Description: Slope
param_pi1_rates

Parameter Description: Pi (1) for Rates
param_three_dots

Parameter Description: "..."
param_thetaH1

Parameter Description: Effect Under Alternative
plot.TrialDesignSet

Trial Design Set Plotting
printCitation

Print Citation
utilitiesForPiecewiseExponentialDistribution

The Piecewise Exponential Distribution
param_stDevH1

Parameter Description: Standard Deviation Under Alternative
testPackage

Test Package
param_typeOfShape

Parameter Description: Type Of Shape
param_userAlphaSpending

Parameter Description: User Alpha Spending
param_stDev

Parameter Description: Standard Deviation
plot.SimulationResults

Simulation Results Plotting
param_nPlanned

Parameter Description: N Planned
utilitiesForSurvivalTrials

Survival Helper Functions for Conversion of Pi, Lambda, Median
param_seed

Parameter Description: Seed
plot.StageResults

Stage Results Plotting
param_thetaH0

Parameter Description: Theta H0
param_selectArmsFunction

Parameter Description: Select Arms Function
param_theta

Parameter Description: Theta
plot.ParameterSet

Parameter Set Plotting
plot.NumberOfSubjects

Number Of Subjects Plotting
readDataset

Read Dataset
readDatasets

Read Multiple Datasets
writeDataset

Write Dataset
writeDatasets

Write Multiple Datasets