fit_xy.nested_model: Fit a nested model to a dataset using an xy interface.

In nestedmodels: Tidy Modelling for Nested Data

Fit a nested model to a dataset using an xy interface.

Description

generics::fit_xy() method for nested models. This should not be called directly and instead should be called by workflows::fit.workflow().

Usage

## S3 method for class 'nested_model'
fit_xy(
  object,
  x,
  y,
  case_weights = NULL,
  control = parsnip::control_parsnip(),
  ...
)

Arguments

object	An nested_model object (see nested()).
x	A data frame of predictors.
y	A data frame of outcome data.
case_weights	An optional vector of case weights. Passed into parsnip::fit.model_spec().
control	A parsnip::control_parsnip() object. Passed into parsnip::fit.model_spec().
...	Passed into parsnip::fit.model_spec(). Currently unused.

Value

A nested_model_fit object with several elements:

• spec: The model specification object (the inner model of the nested model object)

• fit: A tibble containing the model fits and the nests that they correspond to.

• inner_names: A character vector of names, used to help with nesting the data during predictions.

See Also

parsnip::fit.model_spec() parsnip::model_fit

Examples

library(dplyr)
library(parsnip)
library(recipes)
library(workflows)

data <- filter(example_nested_data, id %in% 11:20)

model <- linear_reg() %>%
  set_engine("lm") %>%
  nested()

recipe <- recipe(data, z ~ x + y + id) %>%
  step_nest(id)

wf <- workflow() %>%
  add_recipe(recipe) %>%
  add_model(model)

fit(wf, data)

nestedmodels documentation built on Sept. 30, 2023, 5:06 p.m.