R: Extract Predictor Names from Formula or Terms

form_pred {rsample} | R Documentation

## Extract Predictor Names from Formula or Terms

### Description

'all.vars' returns all variables used in a formula. This function only returns the variables explicitly used on the right-hand side (i.e., it will not resolve dots unless the object is terms with a data set specified).

### Usage

    form_pred(object, ...)

### Arguments

`object` | A model formula or [stats::terms()] object.
`...` | Arguments to pass to [all.vars()]

### Value

A character vector of names

### Examples

    form_pred(y ~ x + z)
    form_pred(terms(y ~ x + z))

    form_pred(y ~ x + log(z))
    form_pred(log(y) ~ x + z)

    form_pred(y1 + y2 ~ x + z)
    form_pred(log(y1) + y2 ~ x + z)

    # will fail:
    # form_pred(y ~ .)

    form_pred(terms(Species ~ (.)^2, data = iris))
    form_pred(terms( ~ (.)^2, data = iris))

[Package rsample version 0.0.2 Index]