Description Usage Arguments Value References

View source: R/cross_fit_estimator.R

This is an internal function typically called from other functions rather than by the user. It creates cross-validation folds and repeatedly calls split_sample_estimator to conduct cross-fitting.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 | ```
cross_fit_estimator(
data,
counterfactual_assignments,
outcome_formula,
treatment_formula,
category_name,
outcome_name,
treatment_name,
treatment_algorithm = "glm",
outcome_algorithm = "lm",
weight_name = NULL,
n_folds = 2,
folds_name = NULL
)
``` |

`data` |
Data frame containing the observed data |

`counterfactual_assignments` |
Numeric scalar or vector of length nrow(data), each element of which is on the [0,1] interval. If a scalar, the counterfactual probability by which all units are assigned to treatment condition 1. If a vector, each element i corresponds to the counterfactual probability by which each unit i is assigned to treatment condition 1. |

`outcome_formula` |
Model formula the outcome. Covariates should include those needed for causal identification of the treatment effect (e.g. as defended in your Directed Acyclic Graph). If |

`treatment_formula` |
Treatment formula, in the style formula(treatment ~ covariates). Covariates should include those needed for causal identification of the treatment effect (e.g. as defended in your Directed Acyclic Graph). |

`category_name` |
Character name of the variable indicating the categories over which the gap is defined. Must be the name of a column in |

`outcome_name` |
Character name of the outcome variable. Only required when there is no outcome_formula; otherwise extracted automatically. Must be a name of a column in |

`treatment_name` |
Character name of the treatment variable. Only required when there is no treatment_formula; otherwise extracted automatically. Must be a name of a column in |

`treatment_algorithm` |
Character name of the algorithm for the treatment model. One of "glm", "ridge", "gam", or "ranger". Defaults to "glm", which is a logit model. Option "ridge" is ridge regression. Option "gam" is a generalized additive model fit (see package |

`outcome_algorithm` |
Character name of the algorithm for the outcome model. One of "lm", "ridge", "gam", or "ranger". Defaults to "lm", which is an OLS model. Option "ridge" is ridge regression. Option "gam" is a generalized additive model fit (see package |

`weight_name` |
Character name of a sampling weight variable, if any, which captures the inverse probability of inclusion in the sample. The default assumes a simple random sample (all weights equal). |

`n_folds` |
Only used if |

`folds_name` |
Only used if |

A list with four elements.

`counterfactual_means`

A tibble with a counterfactual mean estimate for each category
`counterfactual_means`

A tibble with a counterfactual disparity estimate for each pair of categories
`treatment_model`

Object containing the fitted treatment model
`outcome_model`

Object containing the fitted outcome model

Lundberg I (2021). "The gap-closing estimand: A causal approach to study interventions that close disparities across social categories." Sociological Methods and Research. Available at https://osf.io/gx4y3/.

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.