Learn R Programming

⚠️There's a newer version (0.10.8) of this package.Take me there.

optmatch (version 0.10.7)

Functions for Optimal Matching

Description

Distance based bipartite matching using minimum cost flow, oriented to matching of treatment and control groups in observational studies ('Hansen' and 'Klopfer' 2006 ). Routines are provided to generate distances from generalised linear models (propensity score matching), formulas giving variables on which to limit matched distances, stratified or exact matching directives, or calipers, alone or in combination.

Copy Link

Version

Install

install.packages('optmatch')

Monthly Downloads

6,365

Version

0.10.7

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/markmfredrickson/optmatch

Homepage

http://optmat.ch

Maintainer

Josh Errickson

Last Published

November 15th, 2023

Functions in optmatch (0.10.7)

Create EdgeList object

Combine multiple distance specifications into a single distance specification.

cbind.InfinitySparseMatrix

Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row or column

effectiveSampleSize

Compute the effective sample size of a match.

evaluate_primal

Compute value of primal problem given flows and arc costs

compare_optmatch

Compares the equality of optmatch objects, ignoring attributes and group names.

(Internal) Create optmatch objects, the result of matching.

+,InfinitySparseMatrix,InfinitySparseMatrix-method

Element-wise addition

subset.InfinitySparseMatrix

Subsetting for InfinitySparseMatrices

(Internal) Hashing functions for various distance objects #

getMaxProblemSize

What is the maximum allowed problem size?

Generate an exact matching set of subproblems.

Create missingness indicator variables and non-informatively fill in missing values

Create treated to control distances for matching problems

Find the maximum caliper width that will create a feasible problem.

match_on_szn_scale

pooled dispersion for a numeric variable

Find the minimal exact match factors that will be feasible for a given maximum problem size.

Optimal full matching

Diagonally bind together subgroup-specific distances

c,SubProbInfo-method

Combine objects

(Deprecated, in favor of match_on) Create matching distances

Optimal 1:1 and 1:k matching

optmatch_same_distance

Checks if two distances are equivalent. x and y can be distances (InfinitySparseMatrix, BlockedInfinitySparseMatrix, or DenseMatrix), or they can be optmatch objects.

(Internal) Predict for CBPS objects

setMaxProblemSize

Set the maximum problem size

optmatch-defunct

Functions deprecated or removed from optmatch

show,InfinitySparseMatrix-method

Displays an InfinitySparseMatrix

Set thinning and thickening caps for full matching

Printing optmatch objects.

num_eligible_matches

Returns the number of eligible matches for the distance.

stratumStructure

Return structure of matched sets

Identify Stratafication Variables

(Internal) If the x argument does not exist for match_on, fullmatch, or pairmatch, use this function to print a helpful message.

setFeasibilityConstants

(Internal) Sets up the default values for maximum feasible problems

sort.InfinitySparseMatrix

Sort the internal structure of an InfinitySparseMatrix.

update.optmatch

Performs an update on an optmatch object.

(Internal) Helper function to create an InfinitySparseMatrix from a set of scores, a treatment indicator, and a caliper width.

revise_ArcInfo_nodelabels

Reset implicit node labels of an ArcInfo object

Nuclear Power Station Construction Data

Dissimilarities of Some U.S. Nuclear Plants

standardization_scale

pooled dispersion for a numeric variable

model.frame.svyglm

This method quells a warning when optmatch::scores() is applied to a svyglm object.

Extract scores (propensity, prognostic,...) from a fitted model

dimnames,InfinitySparseMatrix-method

Get and set dimnames for InfinitySparseMatrix objects

Returns the dimension of each valid subproblem

findSubproblems

List subproblems of a distance

Identification of units placed into matched sets

fmla2treatedblocking

(Internal) A helper function to turn formulas into treatment and blocking variables

matched.distances

Determine distances between matched units

Summarize a distance matrix

subproblemSuccess

(Internal) Report successful subproblems.

validDistanceSpecification

(Internal) Validate that objects are valid distance specifications.

show,BlockedInfinitySparseMatrix-method

Displays a BlockedInfinitySparseMatrix

optmatch_restrictions

optmatch_restrictions

(Internal) Sets up option to try recovery in fullmatch.

BlockedInfinitySparseMatrix-class

Blocked Infinity Sparse Matrix

as.InfinitySparseMatrix

Convert an object to InfinitySparseMatrix

caliperUpperBound

(Internal) Returns a reasonable upper bound on the arcs remaining after placing a caliper.

as.list.BlockedInfinitySparseMatrix

Splits a BlockedInfinitySparseMatrix into a list of InfinitySparseMatrices

(Internal) Helper function for accessing algorithms in LEMON solver

Combine Optmatch objects

Specify a matching problem where units in a common factor cannot be matched.

InfinitySparseMatrix-class

Objects for sparse matching problems.

(Internal) Determines how many other units fall within a caliper distance

Prepare matching distances suitable for matching within calipers.