crossmap (version 0.3.0)

cross_fit_glm: Cross map a model across multiple formulas, subsets, weights, and functions

Description

Cross map a model across multiple formulas, subsets, weights, and functions

Usage

cross_fit_glm(
  data,
  formulas,
  cols = NULL,
  weights = NULL,
  families = stats::gaussian(link = "identity"),
  fn_args = list(),
  tidy = tidy_glance,
  tidy_args = list(),
  errors = c("stop", "warn")
)

Value

A tibble with subsetting columns, a column for the model formula applied, columns for the model family and type, and columns of tidy model output or a list column of models (if tidy = FALSE)

Arguments

data

A data frame

formulas

A list of formulas to apply to each subset of the data. If named, these names will be used in the model column of the output. Otherwise, the formulas will be converted to strings in the model column.

cols

Columns to subset the data. Can be any expression supported by <tidy-select>. If NULL, the data is not subset into columns. Defaults to NULL.

weights

A list of columns passed to weights in fn. If one of the elements is NULL or NA, that model will not be weighted. Defaults to NULL.

families

A list of glm model families. Defaults to gaussian("identity"), the equivalent of lm(). See family for examples.

fn_args

A list of additional arguments to glm().

tidy

A logical or function to use to tidy model output into data.frame columns. If TRUE, uses the default tidying function: tidy_glance(). If FALSE, NA, or NULL, the untidied model output will be returned in a list column named fit. An alternative function can be specified with an unquoted function name or a purrr-style lambda function with one argument (see usage with broom::tidy(conf.int = TRUE) in examples). Defaults to tidy_glance.

tidy_args

A list of additional arguments to the tidy function

errors

If "stop", the default, the function will stop and return an error if any subset produces an error. If "warn", the function will produce a warning for subsets that produce an error and return results for all subsets that do not.

Examples

cross_fit_glm(
  data     = mtcars,
  formulas = list(am ~ gear, am ~ cyl),
  cols     = vs,
  families = list(gaussian("identity"), binomial("logit"))
)