Function reference • gsDesign2

High-level Functions

Functions to calculate fixed/group sequential design under multiple tests.

fixed_design(): Fixed design sample size

AHR

Functions for the average hazard ratio (AHR) method.

AHR(): Average hazard ratio under non-proportional hazards (test version)

tEvents(): Predict time at which a targeted event count is achieved

eEvents_df(): Expected events observed under piecewise exponential model

gs_info_ahr(): Information and effect size based on AHR approximation

gs_power_ahr(): Group sequential design power using average hazard ratio under non-proportional hazards

gs_design_ahr(): Group sequential design using average hazard ratio under non-proportional hazards

WLR

Functions for the weighted logrank test (WLR) method.

wlr_weight_fh() wlr_weight_1() wlr_weight_n(): Weight Function of Weighted Log-rank Test

gs_info_wlr(): Information and effect size for Weighted Log-rank test

gs_power_wlr(): Group sequential design power using weighted log rank test under non-proportional hazards

gs_design_wlr(): Group sequential design using weighted log-rank test under non-proportional hazards

Max Combo

Functions for the max combo method.

pmvnorm_combo(): Multivariate Normal Distribution for Multivariate Maximum Statistics

gs_info_combo(): Information and effect size for max combo test

gs_spending_combo(): Derive spending bound for MaxCombo group sequential boundary

gs_power_combo(): Group sequential design power using MaxCombo test under non-proportional hazards

gs_design_combo(): Group sequential design using MaxCombo test under non-proportional hazards

Risk differnce

Functions for risk differences.

gs_info_rd(): Information and effect size under risk difference

gs_power_rd(): Group sequential design power under risk difference

gs_design_rd(): Group sequential design using average hazard ratio under non-proportional hazards

Summary and display tables

Functions to summarize fixed / group sequential design results.

summary(): S3 class method to summary fixed or group sequential design

summary(<fixed_design>): summary for fixed_design() object

summary(<gs_design>): This is the function to generate a R table summarizing the bounds in the group sequential design generated by gs_design_ahr or gs_design_wlr or gs_design_combo.

as_gt(): S3 class method to get summary table into a gt table

as_gt(<fixed_design>): This is the function to format the bounds summary table of fixed design into gt style.

as_gt(<gs_design>): This is the function to format the bounds summary table into gt style.

Boundary functions

Functions to specify the upper and lower bound in group sequential designs. They are not recommended to use alone. Instead, they should be used companied with gs_design_npe, gs_power_npe, ect..

gs_b(): gs_b: Default boundary generation

gs_spending_bound(): Derive spending bound for group sequential boundary

Lower level helper functions

Functions to calculate sample size or number of events under non-constant treatment effect over time.

gs_power_npe(): Group sequential bound computation with non-constant effect

gs_design_npe(): Group sequential design computation with non-constant effect and information

eAccrual(): Piecewise constant expected accrual

ahr_blinded(): Blinded estimation of average hazard ratio

ppwe(): Piecewise exponential cumulative distribution function

s2pwe(): Approximate survival distribution with piecewise exponential distribution