Skip to contents

The balancing method specification classes

Source: R/aaa-classes.R
balance_method.Rd

The method constructors (bw_entropy() and its siblings) return small S7 objects that carry tuning parameters and never touch data. They share an abstract hierarchy so that balance() can query a method's capabilities uniformly. balance_method is the abstract root. The estimating-equation family (entropy balancing, inverse probability tilting, the covariate balancing propensity score) subclasses estimating_equation_method; the quadratic-program family (energy, characteristic function distance, and stable balancing weights) subclasses quadratic_program_method. None of the abstract classes can be constructed directly.

Usage

balance_method(convergence_tolerance = NULL, max_iterations = NULL)

estimating_equation_method(convergence_tolerance = NULL, max_iterations = NULL)

quadratic_program_method(
  convergence_tolerance = NULL,
  max_iterations = NULL,
  weight_penalty = numeric(0),
  min_weight = numeric(0)
)

Arguments

convergence_tolerance

The solver convergence tolerance, or NULL to leave it to the solver. The value resolved for NULL differs by family: 1e-10 on the gradient for the estimating-equation methods, and 1e-8 as both the absolute and the relative tolerance for the quadratic-program methods.

max_iterations

The maximum solver iterations, or NULL to leave the cap to the solver. The value resolved for NULL is 1000 for the estimating-equation methods and 200000 for the quadratic-program methods.

weight_penalty

The L2 penalty on the weights.

min_weight

The smallest permitted weight.

Value

An abstract class object. Constructing a concrete subclass returns a balance_method.