Skip to contents

Finds random walk terms in a formula object

Source: R/formula-tools.R
rw_terms.Rd

This function extracts random walk terms denoted using rw() from a formula so that they can be processed on their own.

Usage

rw_terms(formula)

Arguments

formula

A model formula that may use standard fixed effects, random effects using lme4 syntax (see re()), and random walks defined using the rw() helper function. See the Details section below for a comprehensive explanation of the supported syntax.

Value

A character vector containing the random walk terms that have been identified in the supplied formula.

Reference

This function was adapted from code written by J Scott (under an MIT license) as part of the epidemia package (https://github.com/ImperialCollegeLondon/epidemia/).

See also

Functions used to help convert formulas into model designs as_string_formula(), construct_re(), construct_rw(), enw_formula(), enw_manual_formula(), parse_formula(), re(), remove_rw_terms(), rw(), split_formula_to_terms()

Examples

epinowcast:::rw_terms(~ 1 + age_group + location)
#> character(0)

epinowcast:::rw_terms(~ 1 + age_group + location + rw(week, location))
#> [1] "rw(week, location)"