use_contrasts.matrix

If a user provides a raw matrix, then use that matrix as the contrast matrix

Quickly set and summarize contrasts for factors prior to regression analyses. Intended comparisons, baseline conditions, and intercepts can be explicitly set and documented without the user needing to directly manipulate matrices. Reviews and introductions for contrast coding are available in Brehm and Alday (2022)<doi:10.1016/j.jml.2022.104334> and Schad et al. (2020)<doi:10.1016/j.jml.2019.104038>.

Thomas Sostarics

contrastable

Consistent Contrast Coding for Factors

use_contrasts.matrix function

<dl><dt>factor_col</dt>
<dd>A factor vector, eg from df$factorVarName</dd>
<dt>code_by</dt>
<dd>A matrix to be used as the contrast matrix, should have
the same dimensions as the contrast matrix already applied to code_by</dd>
<dt>reference_level</dt>
<dd>Not used</dd>
<dt>set_intercept</dt>
<dd>Not used</dd>
<dt>drop_trends</dt>
<dd>Not used</dd>
<dt>labels</dt>
<dd>A vector of labels to apply to the matrix column names, default</dd>
<dt>as_is</dt>
<dd>Logical, default FALSE, whether to leave the resulting matrix</dd>
<dt>...</dt>
<dd>Additional arguments, not used</dd></dl>

Arguments

Matrix method for use_contrasts — use_contrasts.matrix

<dl>

<dt>factor_col</dt>
<dd>A factor vector, eg from df$factorVarName</dd>


<dt>code_by</dt>
<dd>A matrix to be used as the contrast matrix, should have
the same dimensions as the contrast matrix already applied to code_by</dd>


<dt>reference_level</dt>
<dd>Not used</dd>


<dt>set_intercept</dt>
<dd>Not used</dd>


<dt>drop_trends</dt>
<dd>Not used</dd>


<dt>labels</dt>
<dd>A vector of labels to apply to the matrix column names, default</dd>


<dt>as_is</dt>
<dd>Logical, default FALSE, whether to leave the resulting matrix</dd>


<dt>...</dt>
<dd>Additional arguments, not used</dd>

</dl>

use_contrasts.matrix: Matrix method for use_contrasts

Description

Usage

Value

Arguments

Examples