use_contrasts.AsIs: AsIs method for use_contrasts

View source: R/use_contrast.R

use_contrasts.AsIsR Documentation

AsIs method for use_contrasts

Description

Evaluates code_by, then applies the appropriate use_contrasts method

Usage

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

Arguments

factor_col

A factor vector, eg from df$factorVarName

code_by

A symbol to be evaluated

reference_level

The level to use as the reference level, default NA

set_intercept

The intercept to use, default NA

drop_trends

The trends to drop, default NA

labels

A vector of labels to apply to the matrix column names, default NULL (no new labels)

as_is

Logical, default FALSE, whether to leave the resulting matrix as-is

...

Additional arguments to be passed on

Value

A contrast coding matrix with labels and proper reference level

Examples


use_contrasts(gl(5,1), I(scaled_sum_code))


contrastable documentation built on Oct. 1, 2024, 5:07 p.m.