formula_extraction: Extracting from formulae

frm_outcomeR Documentation

Extracting from formulae

Description

These tools extracting parts from formulae. The only function that extracts from the left-hand side is frm_outcome. The rest only extract from the right-hand side. The word term is used to denote functions that extract full terms from the formula, whereas var denotes functions that extract the variables the formula uses. For example, the formula y ~ a * b + (1 | group) has terms a, b, a:b, and 1 | group. The same formula has variables a, b, and group.

Usage

frm_outcome(frm)

frm_terms(frm)

frm_interaction_terms(frm)

frm_fixed_terms(frm)

frm_random_terms(frm)

frm_vars(frm)

frm_random_vars(frm)

frm_fixed_vars(frm)

Arguments

frm

The formula to extract values from

Details

These tools are ONLY tested against models and formulae that are explicitly supported. See the README and test cases for more information.

Value

The function name and parameters should be descriptive enough (see Description above). The extracted parts are always strings.

See Also

formula_building formula_expansion


supernova documentation built on May 29, 2024, 4:47 a.m.