use_contrasts.function

If the user provides a function, use the function and supplied arguments to
create a 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.function function

<dl><dt>factor_col</dt>
<dd>A factor vector, eg from df$factorVarName</dd>
<dt>code_by</dt>
<dd>A function to be called, should return a contrast matrix</dd>
<dt>reference_level</dt>
<dd>The name of the level to use as the reference level,
default NA</dd>
<dt>set_intercept</dt>
<dd>The intercept to use, default NA</dd>
<dt>drop_trends</dt>
<dd>The trends to drop, default NA</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 to be passed to <code>code_by()</code></dd></dl>

Arguments

Function method for use_contrasts — use_contrasts.function

<dl>

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


<dt>code_by</dt>
<dd>A function to be called, should return a contrast matrix</dd>


<dt>reference_level</dt>
<dd>The name of the level to use as the reference level,
default NA</dd>


<dt>set_intercept</dt>
<dd>The intercept to use, default NA</dd>


<dt>drop_trends</dt>
<dd>The trends to drop, default NA</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 to be passed to <code>code_by()</code></dd>

</dl>

use_contrasts.function: Function method for use_contrasts

Description

Usage

Value

Arguments

Examples