getData: Get Model Data

Description Usage Arguments Details Value See Also Examples

View source: R/stdEff-fun.R

Description

Extract the data used to fit a model.

Usage

1
getData(mod, subset = FALSE, merge = FALSE, env = NULL)

Arguments

mod

A fitted model object, or a list or nested list of such objects.

subset

Logical. If TRUE, only observations used to fit the model(s) are returned (i.e. missing observations (NA) or those with zero weight are removed).

merge

Logical. If TRUE, and mod is a list or nested list, a single dataset containing all variables used to fit models is returned (variables must be the same length).

env

Environment in which to look for data (passed to eval()). Defaults to the formula() environment.

Details

This is a simple convenience function to return the data used to fit a model, by evaluating the 'data' slot of the model call object. If the 'data' argument of the model call was not specified, or is not a data frame (or coercible to such) containing all variables referenced in the model formula, an error will be thrown — this restriction is largely to ensure that a single coherent dataset of all model variables can be made available for resampling purposes.

If mod is a list of models and merge = TRUE, all (unique) variables used to fit models are merged into a single data frame. This will return an error if subset = TRUE results in datasets with different numbers of observations (rows).

Value

A data frame of the variables used to fit the model(s), or a list or nested list of same.

See Also

getCall()

Examples

1
2
3
4
# Get data used to fit SEM from Shipley (2009)
head(getData(shipley.sem[[1]]))  # from single model
lapply(getData(shipley.sem), head)  # from SEM (list)
head(getData(shipley.sem, merge = TRUE))  # from SEM (single dataset)

semEff documentation built on Oct. 12, 2021, 5:06 p.m.