contrastable (version 1.0.2)

use_contrasts.hypr: Use a hypr object for contrasts

Description

Use a hypr object for contrasts

Usage

# S3 method for hypr
use_contrasts(
  factor_col,
  code_by = NA,
  reference_level = NA,
  set_intercept = NA,
  drop_trends = NA,
  labels = NULL,
  as_is = FALSE,
  ...
)

Value

Contrast matrix specified by the hypr object

Arguments

factor_col

A factor vector, eg from df$factorVarName

code_by

A hypr object created with hypr::hypr()

reference_level

Not used

set_intercept

Not used

drop_trends

Not used

labels

A vector of labels to apply to the matrix column names, default

as_is

Logical, default FALSE, whether to leave the resulting matrix

...

Additional arguments, not used

Examples

if (FALSE) { # rlang::is_installed("hypr")
hypr_obj <- hypr::hypr(a ~ b, c ~ b) # centered pairwise comparisons to b

use_contrasts(factor(c('a', 'b', 'c')), hypr_obj)
}