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
  • Adaptive analysis tools for enrichment design testing means, rates, and hazard ratios
  • Automatic boundary recalculations during the trial for analysis with alpha spending approach, including under- and over-running

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

The rpact user group

The rpact project has an active user group consisting of decision-makers and users from the pharmaceutical industry and CROs, who meet regularly and, e.g., discuss best practices.

We invite you to be part of the rpact user group: benefit from know-how, shape open source development in Pharma!

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.1.0

License

LGPL-3

Maintainer

Friedrich Pahlke

Last Published

June 10th, 2021

Functions in rpact (3.1.0)

ConditionalPowerResults

Conditional Power Results
AnalysisResultsMultiArm

Basic Class for Analysis Results Multi-Arm
PowerAndAverageSampleNumberResult_as.data.frame

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

Parameter Description: Allocation Ratio Planned With Optimum Option
PowerAndAverageSampleNumberResult

Power and Average Sample Number Result
DatasetMeans

Dataset of Means
param_conditionalPowerSimulation

Parameter Description: Conditional Power
ParameterSet_print

Print Parameter Set Values
ParameterSet_summary

Parameter Set Summary
getPowerRates

Get Power Rates
AnalysisResultsGroupSequential

Analysis Results Group Sequential
NumberOfSubjects

Number Of Subjects
getDesignInverseNormal

Get Design Inverse Normal
getRepeatedConfidenceIntervals

Get Repeated Confidence Intervals
SimulationResultsMultiArmSurvival

Class for Simulation Results Multi-Arm Survival
Dataset

Dataset
param_hazardRatio

Parameter Description: Hazard Ratio
FrameSet_as.matrix

Coerce Frame Set to a Matrix
getConditionalRejectionProbabilities

Get Conditional Rejection Probabilities
AnalysisResultsMultiArmGroupSequential

Analysis Results Multi-Arm Group Sequential
AnalysisResultsInverseNormal

Analysis Results Inverse Normal
param_epsilonValue

Parameter Description: EpsilonValue
param_lambda2

Parameter Description: Lambda (2)
AnalysisResultsMultiArmInverseNormal

Analysis Results Multi-Arm Inverse Normal
param_median2

Parameter Description: Median (2)
TrialDesignSet_as.data.frame

Coerce Trial Design Set to a Data Frame
FieldSet_print

Print Field Set Values
TrialDesignGroupSequential

Group Sequential Design
param_seed

Parameter Description: Seed
AnalysisResultsMultiArmFisher

Analysis Results Multi-Arm Fisher
param_beta

Parameter Description: Beta
FieldSet_names

Names of a Field Set Object
SimulationResultsRates

Class for Simulation Results Rates
param_niceColumnNamesEnabled

Parameter Description: Nice Column Names Enabled
getEventProbabilities

Get Event Probabilities
ClosedCombinationTestResults

Analysis Results Closed Combination Test
getDesignConditionalDunnett

Get Design Conditional Dunnett Test
SimulationResults_print

Print Simulation Results
PiecewiseSurvivalTime

Piecewise Exponential Survival Time
TrialDesignFisher

Fisher Design
param_alpha

Parameter Description: Alpha
param_minNumberOfEventsPerStage

Parameter Description: Min Number Of Events Per Stage
param_typeOfShape

Parameter Description: Type Of Shape
Trial_Design_Set_summary

Trial Design Set Summary
param_adaptations

Parameter Description: Adaptations
AnalysisResults_names

Names of a Analysis Results Object
TrialDesignConditionalDunnett

Conditional Dunnett Design
AnalysisResultsConditionalDunnett

Analysis Results Multi-Arm Conditional Dunnett
plotTypes

Get Available Plot Types
StageResults

Basic Stage Results
getDesignGroupSequential

Get Design Group Sequential
Dataset_print

Print Dataset Values
Dataset_summary

Dataset Summary
AnalysisResultsEnrichmentInverseNormal

Analysis Results Enrichment Inverse Normal
SimulationResults

Class for Simulation Results
DatasetRates

Dataset of Rates
param_selectArmsFunction

Parameter Description: Select Arms Function
getData

Get Simulation Data
getSampleSizeRates

Get Sample Size Rates
TrialDesignSet

Class for trial design sets.
getSimulationMultiArmMeans

Get Simulation Multi-Arm Means
TrialDesignPlanMeans

Trial Design Plan Means
getLongFormat

Get Long Format
param_rValue

Parameter Description: RValue
getParameterName

Get Parameter Name
getRepeatedPValues

Get Repeated P Values
TrialDesignPlanRates

Trial Design Plan Rates
AnalysisResultsFisher

Analysis Results Fisher
TrialDesign_as.data.frame

Coerce TrialDesign to a Data Frame
SimulationResultsMultiArmRates

Class for Simulation Results Multi-Arm Rates
getDesignFisher

Get Design Fisher
AnalysisResults_summary

Analysis Results Summary
AccrualTime

Accrual Time
getNumberOfSubjects

Get Number Of Subjects
StageResultsSurvival

Stage Results of Survival Data
param_dropoutRate1

Parameter Description: Dropout Rate (1)
getClosedConditionalDunnettTestResults

Get Closed Conditional Dunnett Test Results
SimulationResultsMultiArmMeans

Class for Simulation Results Multi-Arm Means
SimulationResultsMeans

Class for Simulation Results Means
getSimulationMultiArmSurvival

Get Simulation Multi-Arm Survival
kable.ParameterSet

Create output in Markdown
DatasetSurvival

Dataset of Survival Data
param_digits

Parameter Description: Digits
StageResults_as.data.frame

Coerce Stage Results to a Data Frame
TrialDesignSet_names

Names of a Trial Design Set Object
AnalysisResults

Basic Class for Analysis Results
param_kappa

Parameter Description: Kappa
getSimulationMultiArmRates

Get Simulation Multi-Arm Rates
getSampleSizeMeans

Get Sample Size Means
SummaryFactory

Summary Factory
param_informationRates

Parameter Description: Information Rates
param_intersectionTest_MultiArm

Parameter Description: Intersection Test
param_maxNumberOfEventsPerStage

Parameter Description: Max Number Of Events Per Stage
param_bindingFutility

Parameter Description: Binding Futility
getDataset

Get Dataset
PlotSettings

Plot Settings
TrialDesignPlanSurvival

Trial Design Plan Survival
param_successCriterion

Parameter Description: Success Criterion
param_stageResults

Parameter Description: Stage Results
AnalysisResultsEnrichment

Basic Class for Analysis Results Enrichment
param_accrualIntensityType

Parameter Description: Accrual Intensity Type
param_design

Parameter Description: Design
kable

Create tables in Markdown
param_tolerance

Parameter Description: Tolerance
param_dataInput

Parameter Description: Data Input
TrialDesignSet_length

Length of Trial Design Set
StageResults_names

Names of a Stage Results Object
param_maxNumberOfIterations

Parameter Description: Maximum Number Of Iterations
param_plotSettings

Parameter Description: Plot Settings
getParameterCaption

Get Parameter Caption
param_stDev

Parameter Description: Standard Deviation
param_eventTime

Parameter Description: Event Time
plot.Dataset

Dataset Plotting
getSimulationMeans

Get Simulation Means
[,TrialDesignSet-method

Access Trial Design by Index
param_typeOfDesign

Parameter Description: Type of Design
rcmd

Get Object R Code
StageResultsMeans

Stage Results of Means
StageResultsRates

Stage Results of Rates
param_maxInformation

Parameter Description: Maximum Information
getConditionalPower

Get Conditional Power
param_accrualIntensity

Parameter Description: Accrual Intensity
param_directionUpper

Parameter Description: Direction Upper
param_maxNumberOfSubjects

Parameter Description: Maximum Number Of Subjects
param_groups

Parameter Description: Number Of Treatment Groups
readDataset

Read Dataset
param_activeArms

Parameter Description: Active Arms
param_piecewiseSurvivalTime

Parameter Description: Piecewise Survival Time
getDesignSet

Get Design Set
getPiecewiseSurvivalTime

Get Piecewise Survival Time
param_theta

Parameter Description: Theta
param_sided

Parameter Description: Sided
getOutputFormat

Get Output Format
param_accrualTime

Parameter Description: Accrual Time
getDesignCharacteristics

Get Design Characteristics
param_stDevH1

Parameter Description: Standard Deviation Under Alternative
param_design_with_default

Parameter Description: Design with Default
printCitation

Print Citation
param_typeOfSelection

Parameter Description: Type of Selection
setOutputFormat

Set Output Format
getRawData

Get Simulation Raw Data for Survival
param_threshold

Parameter Description: Threshold
TrialDesignCharacteristics_as.data.frame

Coerce TrialDesignCharacteristics to a Data Frame
getSimulationRates

Get Simulation Rates
getPowerSurvival

Get Power Survival
plot.NumberOfSubjects

Number Of Subjects Plotting
param_allocationRatioPlanned

Parameter Description: Allocation Ratio Planned
plot.EventProbabilities

Event Probabilities Plotting
param_maxNumberOfSubjects_survival

Parameter Description: Maximum Number Of Subjects For Survival Endpoint
getPlotSettings

Get Plot Settings
param_stage

Parameter Description: Stage
getPowerMeans

Get Power Means
getTestActions

Get Test Actions
param_alternative

Parameter Description: Alternative
param_includeAllParameters

Parameter Description: Include All Parameters
getWideFormat

Get Wide Format
param_lambda1

Parameter Description: Lambda (1)
param_nPlanned

Parameter Description: N Planned
param_alternative_simulation

Parameter Description: Alternative for Simulation
TrialDesignPlan_as.data.frame

Coerce Trial Design Plan to a Data Frame
param_legendPosition

Parameter Description: Legend Position On Plots
writeDataset

Write Dataset
param_kMax

Parameter Description: Maximum Number of Stages
param_plannedEvents

Parameter Description: Planned Events
writeDatasets

Write Multiple Datasets
param_maxNumberOfSubjectsPerStage

Parameter Description: Maximum Number Of Subjects Per Stage
param_three_dots_plot

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

Parameter Description: User Alpha Spending
param_median1

Parameter Description: Median (1)
getClosedCombinationTestResults

Get Closed Combination Test Results
param_stDevSimulation

Parameter Description: Standard Deviation for Simulation
getObservedInformationRates

Get Observed Information Rates
param_normalApproximation

Parameter Description: Normal Approximation
param_effectMeasure

Parameter Description: Effect Measure
param_conditionalPower

Parameter Description: Conditional Power
plot.ParameterSet

Parameter Set Plotting
param_typeOfComputation

Parameter Description: Type Of Computation
plot.TrialDesignPlan

Trial Design Plan Plotting
getPowerAndAverageSampleNumber

Get Power And Average Sample Number
param_pi1_rates

Parameter Description: Pi (1) for Rates
getSampleSizeSurvival

Get Sample Size Survival
param_informationEpsilon

Parameter Description: Information Epsilon
param_pi2_rates

Parameter Description: Pi (2) for Rates
param_gED50

Parameter Description: G ED50
utilitiesForSurvivalTrials

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

Parameter Description: Palette
param_pi1_survival

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

Trial Design Set Plotting
param_slope

Parameter Description: Slope
param_effectMatrix

Parameter Description: Effect Matrix
utilitiesForPiecewiseExponentialDistribution

The Piecewise Exponential Distribution
param_thetaH0

Parameter Description: Theta H0
plot.AnalysisResults

Analysis Results Plotting
param_grid

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

Parameter Description: Effect Under Alternative
plot.SimulationResults

Simulation Results Plotting
param_three_dots

Parameter Description: "..."
param_pi2_survival

Parameter Description: Pi (2) for Survival Data
plot.StageResults

Stage Results Plotting
rpact

rpact - Confirmatory Adaptive Clinical Trial Design and Analysis
setLogLevel

Set Log Level
param_varianceOption

Parameter Description: Variance Option
TrialDesignPlan

Basic Trial Design Plan
resetLogLevel

Reset Log Level
readDatasets

Read Multiple Datasets
ParameterSet_as.data.frame

Coerce Parameter Set to a Data Frame
plot.TrialDesign

Trial Design Plotting
getAccrualTime

Get Accrual Time
TrialDesign

Basic Trial Design
AnalysisResultsMultiHypotheses

Basic Class for Analysis Results Multi-Hypotheses
EventProbabilities

Event Probabilities
FieldSet

Field Set
TrialDesignInverseNormal

Inverse Normal Design
AnalysisResults_as.data.frame

Coerce AnalysisResults to a Data Frame
SimulationResults_names

Names of a Simulation Results Object
ParameterSet

Parameter Set
TrialDesignCharacteristics

Trial Design Characteristics
SimulationResultsSurvival

Class for Simulation Results Survival
getLogLevel

Get Log Level
param_minNumberOfSubjectsPerStage

Parameter Description: Minimum Number Of Subjects Per Stage
getFinalConfidenceInterval

Get Final Confidence Interval
getAnalysisResults

Get Analysis Results
param_showSource

Parameter Description: Show Source
param_dropoutTime

Parameter Description: Dropout Time
getFinalPValue

Get Final P Value
getStageResults

Get Stage Results
param_calcEventsFunction

Parameter Description: Calculate Events Function
getSimulationSurvival

Get Simulation Survival
param_dropoutRate2

Parameter Description: Dropout Rate (2)
getLambdaStepFunction

Get Lambda Step Function
param_calcSubjectsFunction

Parameter Description: Calculate Subjects Function
param_plannedSubjects

Parameter Description: Planned Subjects
param_nMax

Parameter Description: N_max
plot.SummaryFactory

Summary Factory Plotting
param_plotPointsEnabled

Parameter Description: Plot Points Enabled
param_showStatistics

Parameter Description: Show Statistics
testPackage

Test Package
t,FieldSet-method

Field Set Transpose