Spending functions are used to set boundaries for group sequential designs. Using the spending function approach to design offers a natural way to provide interim testing boundaries when unplanned interim analyses are added or when the timing of an interim analysis changes. Many standard and investigational spending functions are provided in the gsDesign package. These offer a great deal of flexibility in setting up stopping boundaries for a design.

The `summary()`

function for `spendfn`

objects provides a brief textual summary of a spending function or boundary used for a design.

1 2 3 | ```
spendingFunction(alpha, t, param)
## S3 method for class 'spendfn'
summary(object,...)
``` |

`alpha` |
Real value |

`t` |
A vector of points with increasing values from 0 to 1, inclusive. Values of the proportion of sample size/information for which the spending function will be computed. |

`param` |
A single real value or a vector of real values specifying the spending function parameter(s); this must be appropriately matched to the spending function specified. |

`object` |
A spendfn object to be summarized. |

`...` |
Not currently used. |

Spending functions have three arguments as noted above and return an object of type `spendfn`

.
Normally a spending function will be passed to `gsDesign()`

in the parameter `sfu`

for the upper bound and
`sfl`

for the lower bound to specify a spending function family for a design.
In this case, the user does not need to know the calling sequence - only how to specify the parameter(s) for the
spending function.
The calling sequence is useful when the user wishes to plot a spending function as demonstrated below
in examples.
In addition to using supplied spending functions, a user can write code for a spending function.
See examples.

`spendingFunction`

and spending functions in general produce an object of type `spendfn`

.

`name` |
A character string with the name of the spending function. |

`param` |
any parameters used for the spending function. |

`parname` |
a character string or strings with the name(s) of the parameter(s) in |

`sf` |
the spending function specified. |

`spend` |
a vector of cumulative spending values corresponding to the input values in |

`bound` |
this is null when returned from the spending function,
but is set in |

`prob` |
this is null when returned from the spending function,
but is set in |

The manual is not linked to this help file, but is available in library/gsdesign/doc/gsDesignManual.pdf in the directory where R is installed.

Keaven Anderson keaven\_anderson@merck.

Jennison C and Turnbull BW (2000), *Group Sequential Methods with Applications to Clinical Trials*.
Boca Raton: Chapman and Hall.

`gsDesign`

, `sfHSD`

, `sfPower`

,
`sfLogistic`

, `sfExponential`

,
`sfTruncated`

,
Wang-Tsiatis Bounds, gsDesign package overview

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | ```
# Example 1: simple example showing what mose users need to know
# design a 4-analysis trial using a Hwang-Shih-DeCani spending function
# for both lower and upper bounds
x <- gsDesign(k=4, sfu=sfHSD, sfupar=-2, sfl=sfHSD, sflpar=1)
# print the design
x
# summarize the spending functions
summary(x$upper)
summary(x$lower)
# plot the alpha- and beta-spending functions
plot(x, plottype=5)
# what happens to summary if we used a boundary function design
x <- gsDesign(test.type=2,sfu="OF")
y <- gsDesign(test.type=1,sfu="WT",sfupar=.25)
summary(x$upper)
summary(y$upper)
# Example 2: advanced example: writing a new spending function
# Most users may ignore this!
# implementation of 2-parameter version of
# beta distribution spending function
# assumes t and alpha are appropriately specified (does not check!)
sfbdist <- function(alpha, t, param)
{
# check inputs
checkVector(param, "numeric", c(0, Inf), c(FALSE, TRUE))
if (length(param) !=2) stop(
"b-dist example spending function parameter must be of length 2")
# set spending using cumulative beta distribution and return
x <- list(name="B-dist example", param=param, parname=c("a", "b"),
sf=sfbdist, spend=alpha *
pbeta(t, param[1], param[2]), bound=NULL, prob=NULL)
class(x) <- "spendfn"
x
}
# now try it out!
# plot some example beta (lower bound) spending functions using
# the beta distribution spending function
t <- 0:100/100
plot(t, sfbdist(1, t, c(2, 1))$spend, type="l",
xlab="Proportion of information",
ylab="Cumulative proportion of total spending",
main="Beta distribution Spending Function Example")
lines(t, sfbdist(1, t, c(6, 4))$spend, lty=2)
lines(t, sfbdist(1, t, c(.5, .5))$spend, lty=3)
lines(t, sfbdist(1, t, c(.6, 2))$spend, lty=4)
legend(x=c(.65, 1), y=1 * c(0, .25), lty=1:4,
legend=c("a=2, b=1","a=6, b=4","a=0.5, b=0.5","a=0.6, b=2"))
``` |

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.