augment.bfsl: Augment Data with Information from a bfsl Object

In pasturm/bfsl: Best-Fit Straight Line

Augment Data with Information from a bfsl Object

Description

Broom tidier method to augment data with information from a bfsl object.

Usage

## S3 method for class 'bfsl'
augment(x, data = x$data, newdata = NULL, ...)

Arguments

x	A 'bfsl' object created by [bfsl::bfsl()]
data	A [base::data.frame()] or [tibble::tibble()] containing all the original predictors used to create x. Defaults to NULL, indicating that nothing has been passed to newdata. If newdata is specified, the data argument will be ignored.
newdata	A [base::data.frame()] or [tibble::tibble()] containing all the original predictors used to create x. Defaults to NULL, indicating that nothing has been passed to newdata. If newdata is specified, the data argument will be ignored.
...	Unused, included for generic consistency only.

Value

A [tibble::tibble()] with columns:

.fitted	Fitted or predicted value.
.se.fit	Standard errors of fitted values.
.resid	The residuals, that is y observations minus fitted values. (Only returned if newdata = NULL).

Examples

fit = bfsl(pearson_york_data)

augment(fit)

pasturm/bfsl documentation built on Aug. 29, 2022, 3:13 p.m.