SimTestRat: Simultaneous Tests for General Contrasts (Ratios) of Means of...
In SimComp: Simultaneous Comparisons for Multiple Endpoints

Description Usage Arguments Details Value Note Author(s) References See Also Examples

Simultaneous tests for general contrasts (linear functions) of normal means (e.g., "Dunnett", "Tukey", "Williams" ect.), and for single or multiple endpoints (primary response variables) simultaneously. The procedure of Hasler and Hothorn (2012) <doi:10.1080/19466315.2011.633868> is applied for ratios of means of normally distributed data. The variances/ covariance matrices of the treatment groups (containing the covariances between the endpoints) may be assumed to be equal or possibly unequal for the different groups (Hasler, 2014 <doi:10.1515/ijb-2012-0015>). For the case of only a single endpoint and unequal covariance matrices (variances), the procedure coincides with the PI procedure of Hasler and Hothorn (2008) <doi:10.1002/bimj.200710466>.

## Default S3 method:
SimTestRat(data, grp, resp = NULL, na.action = "na.error", type = "Dunnett", 
  base = 1, Num.Contrast = NULL, Den.Contrast = NULL, alternative = "two.sided", 
  Margin = 1, covar.equal = FALSE, CorrMatDat = NULL, ...)
## S3 method for class 'formula'
SimTestRat(formula, ...)

`data`	a data frame containing a grouping variable and the endpoints as columns
`grp`	a character string with the name of the grouping variable
`resp`	a vector of character strings with the names of the endpoints; if `resp=NULL` (default), all column names of the data frame without the grouping variable are chosen automatically
`formula`	a formula specifying a numerical response and a grouping factor (e.g. `response ~ treatment`)
`na.action`	a character string indicating what should happen when the data contain `NAs`; if `na.action="na.error"` (default) the procedure stops with an error message; if `na.action="multi.df"` a new experimental version is used (details will follow soon)
`type`	a character string, defining the type of contrast, with the following options: "Dunnett": many-to-one comparisons "Tukey": all-pair comparisons "Sequen": comparisons of consecutive groups "AVE": comparison of each group with average of all others "GrandMean": comparison of each group with grand mean of all groups "Changepoint": differences of averages of groups of higher order to averages of groups of lower order "Marcus": Marcus contrasts "McDermott": McDermott contrasts "Williams": Williams trend tests "UmbrellaWilliams": Umbrella-protected Williams trend tests note that `type` is ignored if `Num.Contrast` or `Den.Contrast` is specified by the user (see below)
`base`	a single integer specifying the control group for Dunnett contrasts, ignored otherwise
`Num.Contrast`	a numerator contrast matrix, where columns correspond to groups and rows correspond to contrasts
`Den.Contrast`	a denominator contrast matrix, where columns correspond to groups and rows correspond to contrasts
`alternative`	a character string specifying the alternative hypothesis, must be one of `"two.sided"` (default), `"greater"` or `"less"`
`Margin`	a single numeric value, or a numeric vector corresponding to endpoints, or a matrix where columns correspond to endpoints and rows correspond to contrasts
`covar.equal`	a logical variable indicating whether to treat the variances/ covariance matrices of the treatment groups (containing the covariances between the endpoints) as being equal; if `TRUE` then the pooled variance/ covariance matrix is used, otherwise the Satterthwaite approximation to the degrees of freedom is used
`CorrMatDat`	a correlation matrix of the endpoints, if `NULL` (default) it is estimated from the data
`...`	arguments to be passed to SimTestRat.default

The interest is in simultaneous tests for several linear combinations (contrasts) of treatment means in a one-way ANOVA model, and for single or multiple endpoints simultaneously. For example, the all-pair comparison of Tukey (1953) and the many- to-one comparison of Dunnett (1955) are implemented, but allowing for heteroscedasticity and multiple endpoints, and in terms of ratios of means. The user is also free to create other interesting problem-specific contrasts. Approximate multivariate t-distributions are used to calculate (adjusted) p-values (Hasler and Hothorn, 2012 <doi:10.1080/19466315.2011.633868>). This approach controls the familywise error rate in admissible ranges and in the strong sense. The variances/ covariance matrices of the treatment groups (containing the covariances between the endpoints) can be assumed to be equal (covar.equal=TRUE) or unequal (covar.equal=FALSE). If being equal, the pooled variance/ covariance matrix is used, otherwise approximations to the degrees of freedom (Satterthwaite, 1946) are used (Hasler, 2014 <doi:10.1515/ijb-2012-0015>; Hasler and Hothorn, 2008 <doi:10.1002/bimj.200710466>). Unequal covariance matrices occure if variances or correlations of some endpoints differ depending on the treatment groups.

An object of class SimTest containing:

`estimate`	a matrix of estimated differences
`statistic`	a matrix of the calculated test statistics
`p.val.raw`	a matrix of raw p-values
`p.val.adj`	a matrix of p-values adjusted for multiplicity
`CorrMatDat`	if not prespecified by `CorrMatDat`, either the estimated common correlation matrix of the endpoints (`covar.equal=TRUE`) or a list of different (one for each treatment) estimated correlation matrices of the endpoints (`covar.equal=FALSE`)
`CorrMatComp`	the estimated correlation matrix of the comparisons
`degr.fr`	a matrix of degrees of freedom

By default (na.action="na.error"), the procedure stops if there are missing values. A new experimental version for missing values is used if na.action="multi.df". If covar.equal=TRUE, the number of endpoints must not be greater than the total sample size minus the number of treatment groups. If covar.equal=FALSE, the number of endpoints must not be greater than the minimal sample size minus 1. Otherwise the procedure stops.

All hypotheses are tested with the same test direction for all comparisons and endpoints (alternative="..."). In case of doubt, use "two.sided".

If Margin is a single numeric value or a numeric vector, then the same value(s) are used for the remaining comparisons or endpoints.

Mario Hasler

Hasler, M. (2014): Multiple contrast tests for multiple endpoints in the presence of heteroscedasticity. The International Journal of Biostatistics 10, 17–28, <doi:10.1515/ijb-2012-0015>.

Hasler, M. and Hothorn, L.A. (2012): A multivariate Williams-type trend procedure. Statistics in Biopharmaceutical Research 4, 57–65, <doi:10.1080/19466315.2011.633868>.

Hasler, M. and Hothorn, L.A. (2008): Multiple contrast tests in the presence of heteroscedasticity. Biometrical Journal 50, 793–800, <doi:10.1002/bimj.200710466>.

Dilba, G. et al. (2006): Simultaneous confidence sets and confidence intervals for multiple ratios. Journal of Statistical Planning and Inference 136, 2640–2658, <doi:10.1016/j.jspi.2004.11.009>.

SimCiRat, SimTestDiff, SimCiDiff

# Example 1:
# A comparison of the groups B and H against the standard S, for endpoint
# Thromb.count, assuming unequal variances for the groups. This is an
# extension of the well-known Dunnett-test to the case of heteroscedasticity 
# and in terms of ratios of means instead of differences.

data(coagulation)

comp1 <- SimTestRat(data=coagulation, grp="Group", resp="Thromb.count",
  type="Dunnett", base=3, alternative="greater", covar.equal=FALSE)
comp1

# Example 2:
# A comparison of the groups B and H against the standard S, simultaneously
# for all endpoints, assuming unequal covariance matrices for the groups. This is
# an extension of the well-known Dunnett-test to the case of heteroscedasticity
# and multiple endpoints and in terms of ratios of means instead of differences.

data(coagulation)

comp2 <- SimTestDiff(data=coagulation, grp="Group", resp=c("Thromb.count","ADP","TRAP"),
  type="Dunnett", base=3, alternative="greater", covar.equal=FALSE)
summary(comp2)