Learn R Programming

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

Status](https://www.r-pkg.org/badges/version/rpact)](https://cran.r-project.org/package=rpact)

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 and simulation 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 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. The validation documentation contains the personal access data for performing the installation qualification with testPackage().

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 R/Shiny software development services
    • technical support for the rpact package
    • consultancy and user training for scientists 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.4.0

License

LGPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Friedrich Pahlke

Last Published

July 3rd, 2023

Functions in rpact (3.4.0)

AnalysisResultsMultiArm

Basic Class for Analysis Results Multi-Arm
AnalysisResultsEnrichment

Basic Class for Analysis Results Enrichment
AnalysisResultsEnrichmentInverseNormal

Analysis Results Enrichment Inverse Normal
AnalysisResultsInverseNormal

Analysis Results Inverse Normal
AccrualTime

Accrual Time
AnalysisResultsEnrichmentFisher

Analysis Results Enrichment Fisher
AnalysisResults

Basic Class for Analysis Results
AnalysisResultsConditionalDunnett

Analysis Results Multi-Arm Conditional Dunnett
AnalysisResultsFisher

Analysis Results Fisher
AnalysisResultsGroupSequential

Analysis Results Group Sequential
AnalysisResultsMultiArmInverseNormal

Analysis Results Multi-Arm Inverse Normal
ConditionalPowerResults

Conditional Power Results
AnalysisResultsMultiArmFisher-class

Analysis Results Multi-Arm Fisher
ConditionalPowerResultsSurvival

Conditional Power Results Survival
ConditionalPowerResultsEnrichmentRates

Conditional Power Results Enrichment Rates
ConditionalPowerResultsEnrichmentMeans

Conditional Power Results Enrichment Means
ConditionalPowerResultsMeans

Conditional Power Results Means
NumberOfSubjects

Number Of Subjects
ConditionalPowerResultsRates

Conditional Power Results Rates
EventProbabilities

Event Probabilities
DatasetRates

Dataset of Rates
DatasetMeans

Dataset of Means
Dataset

Dataset
FieldSet

Field Set
AnalysisResultsMultiHypotheses

Basic Class for Analysis Results Multi-Hypotheses
PerformanceScore

Performance Score
PiecewiseSurvivalTime

Piecewise Exponential Survival Time
ParameterSet

Parameter Set
ClosedCombinationTestResults

Analysis Results Closed Combination Test
SimulationResultsMultiArmSurvival

Class for Simulation Results Multi-Arm Survival
SimulationResultsEnrichmentRates

Class for Simulation Results Enrichment Rates
PlotSettings

Plot Settings
SimulationResultsMultiArmRates

Class for Simulation Results Multi-Arm Rates
SimulationResultsMeans

Class for Simulation Results Means
DatasetSurvival

Dataset of Survival Data
PowerAndAverageSampleNumberResult

Power and Average Sample Number Result
SimulationResultsMultiArmMeans

Class for Simulation Results Multi-Arm Means
SimulationResultsEnrichmentSurvival

Class for Simulation Results Enrichment Survival
StageResultsMeans

Stage Results of Means
SimulationResultsRates

Class for Simulation Results Rates
StageResults

Basic Stage Results
StageResultsEnrichmentMeans

Stage Results Enrichment Means
StageResultsEnrichmentRates

Stage Results Enrichment Rates
StageResultsMultiArmRates

Stage Results Multi Arm Rates
StageResultsMultiArmSurvival

Stage Results Multi Arm Survival
SimulationResultsSurvival

Class for Simulation Results Survival
SimulationResultsEnrichmentMeans

Class for Simulation Results Enrichment Means
TrialDesignFisher

Fisher Design
StageResultsEnrichmentSurvival

Stage Results Enrichment Survival
SimulationResults

Class for Simulation Results
StageResultsRates

Stage Results of Rates
SummaryFactory

Summary Factory
StageResultsSurvival

Stage Results of Survival Data
StageResultsMultiArmMeans

Stage Results Multi Arm Means
TrialDesignGroupSequential

Group Sequential Design
TrialDesign

Basic Trial Design
TrialDesignConditionalDunnett

Conditional Dunnett Design
as.data.frame.StageResults

Coerce Stage Results to a Data Frame
TrialDesignPlan

Basic Trial Design Plan
as.data.frame.ParameterSet

Coerce Parameter Set to a Data Frame
TrialDesignPlanMeans

Trial Design Plan Means
TrialDesignCharacteristics

Trial Design Characteristics
as.data.frame.TrialDesignCharacteristics

Coerce TrialDesignCharacteristics to a Data Frame
as.data.frame.PowerAndAverageSampleNumberResult

Coerce Power And Average Sample Number Result to a Data Frame
as.data.frame.TrialDesign

Coerce TrialDesign to a Data Frame
dataEnrichmentRatesStratified

Stratified Enrichment Dataset of Rates
TrialDesignPlanRates

Trial Design Plan Rates
TrialDesignInverseNormal

Inverse Normal Design
as.data.frame.AnalysisResults

Coerce AnalysisResults to a Data Frame
TrialDesignPlanSurvival

Trial Design Plan Survival
dataEnrichmentSurvival

Enrichment Dataset of Survival Data
dataEnrichmentSurvivalStratified

Stratified Enrichment Dataset of Survival Data
as.matrix.FieldSet

Coerce Field Set to a Matrix
getAnalysisResults

Get Analysis Results
as.data.frame.TrialDesignPlan

Coerce Trial Design Plan to a Data Frame
as.data.frame.TrialDesignSet

Coerce Trial Design Set to a Data Frame
plotTypes

Get Available Plot Types
dataEnrichmentMeansStratified

Stratified Enrichment Dataset of Means
TrialDesignSet

Class for trial design sets.
dataEnrichmentRates

Enrichment Dataset of Rates
dataMultiArmMeans

Multi-Arm Dataset of Means
dataMeans

One-Arm Dataset of Means
dataEnrichmentMeans

Enrichment Dataset of Means
dataMultiArmRates

Multi-Arm Dataset of Rates
dataMultiArmSurvival

Multi-Arm Dataset of Survival Data
getClosedConditionalDunnettTestResults

Get Closed Conditional Dunnett Test Results
getClosedCombinationTestResults

Get Closed Combination Test Results
getDesignCharacteristics

Get Design Characteristics
getDesignConditionalDunnett

Get Design Conditional Dunnett Test
getConditionalRejectionProbabilities

Get Conditional Rejection Probabilities
getConditionalPower

Get Conditional Power
getDesignSet

Get Design Set
getFinalConfidenceInterval

Get Final Confidence Interval
getDesignInverseNormal

Get Design Inverse Normal
getLongFormat

Get Long Format
getNumberOfSubjects

Get Number Of Subjects
getEventProbabilities

Get Event Probabilities
getLambdaStepFunction

Get Lambda Step Function
getDesignGroupSequential

Get Design Group Sequential
getDesignFisher

Get Design Fisher
rcmd

Get Object R Code
getDataset

Get Dataset
dataSurvival

One-Arm Dataset of Survival Data
getLogLevel

Get Log Level
getObservedInformationRates

Get Observed Information Rates
getData

Get Simulation Data
getAccrualTime

Get Accrual Time
getPowerAndAverageSampleNumber

Get Power And Average Sample Number
getGroupSequentialProbabilities

Get Group Sequential Probabilities
dataRates

One-Arm Dataset of Rates
getPowerRates

Get Power Rates
getFinalPValue

Get Final P Value
getPowerMeans

Get Power Means
getPiecewiseSurvivalTime

Get Piecewise Survival Time
getPlotSettings

Get Plot Settings
getPowerSurvival

Get Power Survival
getOutputFormat

Get Output Format
getParameterCaption

Get Parameter Caption
getParameterName

Get Parameter Name
getPerformanceScore

Get Performance Score
getRepeatedPValues

Get Repeated P Values
getSampleSizeMeans

Get Sample Size Means
getSimulationEnrichmentSurvival

Get Simulation Enrichment Survival
getSimulationEnrichmentMeans

Get Simulation Enrichment Means
getSampleSizeRates

Get Sample Size Rates
getSimulationMeans

Get Simulation Means
getRepeatedConfidenceIntervals

Get Repeated Confidence Intervals
getSimulationEnrichmentRates

Get Simulation Enrichment Rates
getRawData

Get Simulation Raw Data for Survival
getSampleSizeSurvival

Get Sample Size Survival
getWideFormat

Get Wide Format
kable

Create tables in Markdown
getStageResults

Get Stage Results
kable.ParameterSet

Create output in Markdown
getTestActions

Get Test Actions
getSimulationMultiArmRates

Get Simulation Multi-Arm Rates
getSimulationMultiArmMeans

Get Simulation Multi-Arm Means
getSimulationMultiArmSurvival

Get Simulation Multi-Arm Survival
getSimulationSurvival

Get Simulation Survival
getSimulationRates

Get Simulation Rates
names.SimulationResults

Names of a Simulation Results Object
knit_print.ParameterSet

Print Parameter Set in Markdown Code Chunks
names.TrialDesignSet

Names of a Trial Design Set Object
names.StageResults

Names of a Stage Results Object
param_accrualIntensityType

Parameter Description: Accrual Intensity Type
param_accrualTime

Parameter Description: Accrual Time
param_allocationRatioPlanned_sampleSize

Parameter Description: Allocation Ratio Planned With Optimum Option
param_allocationRatioPlanned

Parameter Description: Allocation Ratio Planned
length.TrialDesignSet

Length of Trial Design Set
param_digits

Parameter Description: Digits
param_dropoutRate1

Parameter Description: Dropout Rate (1)
param_activeArms

Parameter Description: Active Arms
param_adaptations

Parameter Description: Adaptations
names.AnalysisResults

Names of a Analysis Results Object
param_alpha

Parameter Description: Alpha
param_alternative

Parameter Description: Alternative
param_bindingFutility

Parameter Description: Binding Futility
param_directionUpper

Parameter Description: Direction Upper
param_gED50

Parameter Description: G ED50
param_dataInput

Parameter Description: Data Input
names.FieldSet

Names of a Field Set Object
param_calcSubjectsFunction

Parameter Description: Calculate Subjects Function
param_accrualIntensity

Parameter Description: Accrual Intensity
param_conditionalPower

Parameter Description: Conditional Power
param_alternative_simulation

Parameter Description: Alternative for Simulation
param_epsilonValue

Parameter Description: Epsilon Value
param_conditionalPowerSimulation

Parameter Description: Conditional Power
param_grid

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

Parameter Description: Dropout Time
param_design

Parameter Description: Design
param_beta

Parameter Description: Beta
param_populations

Parameter Description: Populations
param_dropoutRate2

Parameter Description: Dropout Rate (2)
param_normalApproximation

Parameter Description: Normal Approximation
param_kappa

Parameter Description: Kappa
param_legendPosition

Parameter Description: Legend Position On Plots
param_eventTime

Parameter Description: Event Time
param_effectList

Parameter Description: Effect List
param_maxNumberOfIterations

Parameter Description: Maximum Number Of Iterations
param_lambda2

Parameter Description: Lambda (2)
param_niceColumnNamesEnabled

Parameter Description: Nice Column Names Enabled
param_lambda1

Parameter Description: Lambda (1)
param_rValue

Parameter Description: R Value
param_median2

Parameter Description: Median (2)
param_pi2_survival

Parameter Description: Pi (2) for Survival Data
param_seed

Parameter Description: Seed
param_successCriterion

Parameter Description: Success Criterion
param_calcEventsFunction

Parameter Description: Calculate Events Function
param_median1

Parameter Description: Median (1)
param_stratifiedAnalysis

Parameter Description: Stratified Analysis
param_piecewiseSurvivalTime

Parameter Description: Piecewise Survival Time
param_threshold

Parameter Description: Threshold
param_nMax

Parameter Description: N_max
param_selectArmsFunction

Parameter Description: Select Arms Function
param_includeAllParameters

Parameter Description: Include All Parameters
param_three_dots_plot

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

Parameter Description: Design with Default
param_groups

Parameter Description: Number Of Treatment Groups
param_maxNumberOfSubjectsPerStage

Parameter Description: Maximum Number Of Subjects Per Stage
param_informationEpsilon

Parameter Description: Information Epsilon
param_nPlanned

Parameter Description: N Planned
param_maxNumberOfSubjects_survival

Parameter Description: Maximum Number Of Subjects For Survival Endpoint
print.Dataset

Print Dataset Values
param_hazardRatio

Parameter Description: Hazard Ratio
param_showStatistics

Parameter Description: Show Statistics
param_effectMeasure

Parameter Description: Effect Measure
[,TrialDesignSet-method

Access Trial Design by Index
print.FieldSet

Print Field Set Values
param_effectMatrix

Parameter Description: Effect Matrix
summary.AnalysisResults

Analysis Results Summary
param_typeOfShape

Parameter Description: Type Of Shape
param_sided

Parameter Description: Sided
plot.StageResults

Stage Results Plotting
plot.SimulationResults

Simulation Results Plotting
param_typeOfDesign

Parameter Description: Type of Design
param_typeOfSelection

Parameter Description: Type of Selection
param_plannedEvents

Parameter Description: Planned Events
param_plannedSubjects

Parameter Description: Planned Subjects
readDatasets

Read Multiple Datasets
readDataset

Read Dataset
param_userAlphaSpending

Parameter Description: User Alpha Spending
plot.TrialDesignPlan

Trial Design Plan Plotting
plot.TrialDesignSet

Trial Design Set Plotting
param_maxNumberOfSubjects

Parameter Description: Maximum Number Of Subjects
summary.Dataset

Dataset Summary
param_selectPopulationsFunction

Parameter Description: Select Populations Function
utilitiesForSurvivalTrials

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

Write Multiple Datasets
writeDataset

Write Dataset
utilitiesForPiecewiseExponentialDistribution

The Piecewise Exponential Distribution
printCitation

Print Citation
rawDataTwoArmNormal

Raw Dataset Of A Two Arm Continuous Outcome With Covariates
param_stDev

Parameter Description: Standard Deviation
param_three_dots

Parameter Description: "..."
param_thetaH1

Parameter Description: Effect Under Alternative
param_slope

Parameter Description: Slope
param_showSource

Parameter Description: Show Source
plot.AnalysisResults

Analysis Results Plotting
param_informationRates

Parameter Description: Information Rates
summary.ParameterSet

Parameter Set Summary
param_varianceOption

Parameter Description: Variance Option
param_intersectionTest_MultiArm

Parameter Description: Intersection Test
print.SimulationResults

Print Simulation Results
print.ParameterSet

Print Parameter Set Values
param_kMax

Parameter Description: Maximum Number of Stages
param_plotPointsEnabled

Parameter Description: Plot Points Enabled
param_maxInformation

Parameter Description: Maximum Information
param_minNumberOfEventsPerStage

Parameter Description: Min Number Of Events Per Stage
param_minNumberOfSubjectsPerStage

Parameter Description: Minimum Number Of Subjects Per Stage
param_intersectionTest_Enrichment

Parameter Description: Intersection Test
param_pi1_survival

Parameter Description: Pi (1) for Survival Data
param_plotSettings

Parameter Description: Plot Settings
param_pi2_rates

Parameter Description: Pi (2) for Rates
param_palette

Parameter Description: Palette
param_tolerance

Parameter Description: Tolerance
param_maxNumberOfEventsPerStage

Parameter Description: Max Number Of Events Per Stage
param_stDevSimulation

Parameter Description: Standard Deviation for Simulation
param_stDevH1

Parameter Description: Standard Deviation Under Alternative
plot.Dataset

Dataset Plotting
plot.EventProbabilities

Event Probabilities Plotting
param_typeOfComputation

Parameter Description: Type Of Computation
plot.SummaryFactory

Summary Factory Plotting
plot.TrialDesign

Trial Design Plotting
setOutputFormat

Set Output Format
setLogLevel

Set Log Level
param_pi1_rates

Parameter Description: Pi (1) for Rates
param_stage

Parameter Description: Stage
param_stageResults

Parameter Description: Stage Results
testPackage

Test Package
print.TrialDesignCharacteristics

Trial Design Characteristics Printing
plot.NumberOfSubjects

Number Of Subjects Plotting
param_thetaH0

Parameter Description: Theta H0
test_plan_section

Test Plan Section
print.SummaryFactory

Summary Factory Printing
plot.ParameterSet

Parameter Set Plotting
rpact

rpact - Confirmatory Adaptive Clinical Trial Design and Analysis
resetLogLevel

Reset Log Level
param_theta

Parameter Description: Theta
t,FieldSet-method

Field Set Transpose
summary.TrialDesignSet

Trial Design Set Summary