match_propensity_list: match_propensity_list

Description Usage Arguments Value

View source: R/match_propensity_list.R

Description

Generates the propensity parameters used for using propensity-based calipers.

Usage

1
2
3
4
5
6
7
match_propensity_list(
  propensity_function = propensity_score_xgb(),
  oos_propensity = FALSE,
  n_folds = NULL,
  caliper_sd_mult = 0.6,
  continuous_mult = 100
)

Arguments

propensity_function

A function that accepts a list with four elements: x_train, x_test, y_train, y_test, and forms predictions using x_test (I guess y_test isn't used yet)

oos_propensity

Logical, whether to predict out of sample for the propensity score.

n_folds

Default NULL; how many folds if using out of sample propensity.

caliper_sd_mult

Maximum gap between units.In sd(propensity_score) * k, where this parameter is the value k. Default 0.6.

continuous_mult

Penality for going above a certain caliper.

Value

list with names equal to all input params


rzgross/uRbanmatching documentation built on Dec. 22, 2021, 8:20 p.m.