hmat: Retrieve and set hypothesis matrix

In hypr: Hypothesis Matrix Translation

Retrieve and set hypothesis matrix

Description

Use these functions to retrieve or set a hypr object's hypothesis matrix. If used for updating, the contrast matrix and equations are derived automatically.

Usage

hmat(x, as_fractions = TRUE)

thmat(x, as_fractions = TRUE)

hmat(x) <- value

thmat(x) <- value

Arguments

x	A hypr object
as_fractions	Whether to format matrix as fractions (via MASS::as.fractions)
value	Hypothesis matrix

Value

Hypothesis matrix of x

Functions

• thmat(): Retrieve transposed hypothesis matrix

• hmat(x) <- value: Set hypothesis matrix

• thmat(x) <- value: Set transposed hypothesis matrix

Examples

h <- hypr(mu1~0, mu2~mu1)

# To retrieve the hypothesis matrix of `h`:
hmat(h)

# To retrieve the transposed hypothesis matrix of `h`:
thmat(h)

# Setting the hypothesis matrix of `h`:
hmat(h) <- matrix(c(1,-1,0,1), ncol=2, dimnames=list(NULL, c("mu1","mu2")))
h

h2 <- hypr() # an empty hypr object
thmat(h2) <- matrix(c(1,0,-1,1), ncol=2, dimnames=list(c("mu1","mu2"), NULL))
h2

# `h` and `h2` should be identical:
stopifnot(all.equal(hmat(h), hmat(h2)))
stopifnot(all.equal(cmat(h), cmat(h2)))

hypr documentation built on Nov. 9, 2023, 5:06 p.m.