# Group Sequential Design

## Documentation for package ‘gsDesign’ version 3.10.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C E G H I N P R S T V X Z

## -- A --

as_gt | Convert a summary table object to a gt object
as_gt.gsBinomialExactTable | Convert a summary table object to a gt object
as_rtf | Save a summary table object as an RTF file
as_rtf.gsBinomialExactTable | Save a summary table object as an RTF file
as_rtf.gsBoundSummary | Save a summary table object as an RTF file
as_table | Create a summary table
as_table.gsBinomialExact | Create a summary table

## -- B --

binomialPowerTable | Power Table for Binomial Tests
binomialSPRT | One-Sample Binomial Routines

## -- C --

checkLengths | Utility functions to verify variable properties
checkRange | Utility functions to verify variable properties
checkScalar | Utility functions to verify variable properties
checkVector | Utility functions to verify variable properties
ciBinomial | Testing, Confidence Intervals, Sample Size and Power for Comparing Two Binomial Rates
condPower | Sample size re-estimation based on conditional power

## -- E --

eEvents | Expected number of events for a time-to-event study

## -- G --

gsBinomialExact | One-Sample Binomial Routines
gsBound | Boundary derivation - low level
gsBound1 | Boundary derivation - low level
gsBoundCP | Conditional Power at Interim Boundaries
gsBoundSummary | Bound Summary and Z-transformations
gsBValue | Bound Summary and Z-transformations
gsCP | Conditional and Predictive Power, Overall and Conditional Probability of Success
gsCPOS | Conditional and Predictive Power, Overall and Conditional Probability of Success
gsCPz | Bound Summary and Z-transformations
gsDelta | Bound Summary and Z-transformations
gsDensity | Group sequential design interim density function
gsDesign | Design Derivation
gsHR | Bound Summary and Z-transformations
gsPI | Conditional and Predictive Power, Overall and Conditional Probability of Success
gsPOS | Conditional and Predictive Power, Overall and Conditional Probability of Success
gsPosterior | Conditional and Predictive Power, Overall and Conditional Probability of Success
gsPP | Conditional and Predictive Power, Overall and Conditional Probability of Success
gsProbability | Boundary Crossing Probabilities
gsRR | Bound Summary and Z-transformations
gsSurv | Advanced time-to-event sample size calculation
gsSurvCalendar | Group sequential design with calendar-based timing of analyses
gsSurvPower | Compute power for a group sequential survival design

## -- H --

hrn2z | Time-to-event sample size calculation (Lachin-Foulkes)
hrz2n | Time-to-event sample size calculation (Lachin-Foulkes)

## -- I --

isInteger | Utility functions to verify variable properties

## -- N --

nBinomial | Testing, Confidence Intervals, Sample Size and Power for Comparing Two Binomial Rates
nBinomial1Sample | One-Sample Binomial Routines
nEvents | Time-to-event sample size calculation (Lachin-Foulkes)
nEventsIA | Advanced time-to-event sample size calculation
nNormal | Normal distribution sample size (2-sample)
normalGrid | Normal Density Grid
nSurv | Advanced time-to-event sample size calculation
nSurvival | Time-to-event sample size calculation (Lachin-Foulkes)

## -- P --

plot.binomialSPRT | One-Sample Binomial Routines
plot.gsBinomialExact | One-Sample Binomial Routines
plot.gsDesign | Plots for group sequential designs
plot.gsProbability | Plots for group sequential designs
plot.ssrCP | Sample size re-estimation based on conditional power
Power.ssrCP | Sample size re-estimation based on conditional power
print.eEvents | Expected number of events for a time-to-event study
print.gsBinomialExact | One-Sample Binomial Routines
print.gsBoundSummary | Bound Summary and Z-transformations
print.gsDesign | Bound Summary and Z-transformations
print.gsProbability | Boundary Crossing Probabilities
print.gsSurv | Advanced time-to-event sample size calculation
print.nSurv | Advanced time-to-event sample size calculation
print.nSurvival | Time-to-event sample size calculation (Lachin-Foulkes)

## -- R --

repeatedPValueBinomialExact | Exact binomial repeated p-values for a group sequential design

## -- S --

sequentialPValue | Sequential p-value computation
sequentialPValueBinomialExact | Exact binomial sequential p-value for a group sequential design
sfBetaDist | Two-parameter Spending Function Families
sfCauchy | Two-parameter Spending Function Families
sfExponential | Exponential Spending Function
sfExtremeValue | Two-parameter Spending Function Families
sfExtremeValue2 | Two-parameter Spending Function Families
sfGapped | Truncated, trimmed and gapped spending functions
sfHSD | Hwang-Shih-DeCani Spending Function
sfLDOF | Lan-DeMets Spending function overview
sfLDPocock | Lan-DeMets Spending function overview
sfLinear | Piecewise Linear and Step Function Spending Functions
sfLogistic | Two-parameter Spending Function Families
sfNormal | Two-parameter Spending Function Families
sfPoints | Pointwise Spending Function
sfPower | Kim-DeMets (power) Spending Function
sfStep | Piecewise Linear and Step Function Spending Functions
sfTDist | t-distribution Spending Function
sfTrimmed | Truncated, trimmed and gapped spending functions
sfTruncated | Truncated, trimmed and gapped spending functions
sfXG | Xi and Gallo conditional error spending functions
sfXG1 | Xi and Gallo conditional error spending functions
sfXG2 | Xi and Gallo conditional error spending functions
sfXG3 | Xi and Gallo conditional error spending functions
simBinomial | Testing, Confidence Intervals, Sample Size and Power for Comparing Two Binomial Rates
simBinomialSeasonalExact | Simulate exact-binomial seasonal monitoring scenarios
spendingFunction | Spending Function
ssrCP | Sample size re-estimation based on conditional power
summary.gsDesign | Bound Summary and Z-transformations
summary.spendfn | Spending Function

## -- T --

testBinomial | Testing, Confidence Intervals, Sample Size and Power for Comparing Two Binomial Rates
tEventsIA | Advanced time-to-event sample size calculation
toBinomialExact | Translate survival design bounds to exact binomial bounds
toInteger | Translate group sequential design to integer events (survival designs) or sample size (other designs)

## -- V --

varBinomial | Testing, Confidence Intervals, Sample Size and Power for Comparing Two Binomial Rates

## -- X --

xprint | Bound Summary and Z-transformations
xtable | xtable
xtable.gsDesign | Design Derivation
xtable.gsSurv | Advanced time-to-event sample size calculation

## -- Z --

z2Fisher | Sample size re-estimation based on conditional power
z2NC | Sample size re-estimation based on conditional power
z2Z | Sample size re-estimation based on conditional power
zn2hr | Time-to-event sample size calculation (Lachin-Foulkes)