optmatch0.10.8 package

Functions for Optimal Matching

antiExactMatch

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

as.InfinitySparseMatrix

Convert an object to InfinitySparseMatrix

as.list.BlockedInfinitySparseMatrix

Splits a BlockedInfinitySparseMatrix into a list of InfinitySparseMatr...

BlockedInfinitySparseMatrix-class

Blocked Infinity Sparse Matrix

c.optmatch

Combine Optmatch objects

caliper-methods

Prepare matching distances suitable for matching within calipers.

caliperSize

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

caliperUpperBound

(Internal) Returns a reasonable upper bound on the arcs remaining afte...

cbindrbind

Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row...

compare_optmatch

Compares the equality of optmatch objects, ignoring attributes and gro...

dbind

Diagonally bind together subgroup-specific distances

dimnames-InfinitySparseMatrix

Get and set dimnames for InfinitySparseMatrix objects

distUnion

Combine multiple distance specifications into a single distance specif...

edgelist

Create EdgeList object

effectiveSampleSize

Compute the effective sample size of a match.

evaluate_primal

Compute value of primal problem given flows and arc costs

exactMatch

Generate an exact matching set of subproblems.

fill.NAs

Create missingness indicator variables and non-informatively fill in m...

findSubproblems

List subproblems of a distance

fmla2treatedblocking

(Internal) A helper function to turn formulas into treatment and block...

fullmatch

Optimal full matching

getMaxProblemSize

What is the maximum allowed problem size?

hash_dist

(Internal) Hashing functions for various distance objects #

InfinitySparseMatrix-class

Objects for sparse matching problems.

ism.subset

Subsetting for InfinitySparseMatrices

ismBinaryOps

Element-wise addition

LEMON

(Internal) Helper function for accessing algorithms in LEMON solver

makeOptmatch

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

match_on_szn_scale

pooled dispersion for a numeric variable

match_on-methods

Create treated to control distances for matching problems

matched.distances

Determine distances between matched units

matched

Identification of units placed into matched sets

maxCaliper

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

mcf_c_fns

Combine objects

mdist

(Deprecated, in favor of match_on) Create matching distances

minExactMatch

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

minmaxctlcap

Set thinning and thickening caps for full matching

missing_x_msg

(Internal) If the x argument does not exist for match_on, fullmatch, o...

model.frame.svyglm

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

num_eligible_matches-methods

Returns the number of eligible matches for the distance.

optmatch_restrictions

optmatch_restrictions

optmatch_same_distance

Checks if two distances are equivalent. x and y can be distances (...

optmatch-defunct

Functions deprecated or removed from optmatch

optmatch

Optmatch Class

pairmatch

Optimal 1:1 and 1:k matching

predict.CBPS

(Internal) Predict for CBPS objects

print.optmatch

Printing optmatch objects.

revise_ArcInfo_nodelabels

Reset implicit node labels of an ArcInfo object

scoreCaliper

(Internal) Helper function to create an InfinitySparseMatrix from a se...

scores

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

setFeasibilityConstants

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

setMaxProblemSize

Set the maximum problem size

setTryRecovery

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

show-BlockedInfinitySparseMatrix-method

Displays a BlockedInfinitySparseMatrix

show-InfinitySparseMatrix-method

Displays an InfinitySparseMatrix

sort.ism

Sort the internal structure of an InfinitySparseMatrix.

standardization_scale

pooled dispersion for a numeric variable

strata

Identify Stratafication Variables

stratumStructure

Return structure of matched sets

subdim-methods

Returns the dimension of each valid subproblem

subproblemSuccess

(Internal) Report successful subproblems.

summary.ism

Summarize a distance matrix

update.optmatch

Performs an update on an optmatch object.

validDistanceSpecification

(Internal) Validate that objects are valid distance specifications.

Distance based bipartite matching using minimum cost flow, oriented to matching of treatment and control groups in observational studies ('Hansen' and 'Klopfer' 2006 <doi:10.1198/106186006X137047>). 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.

  • Maintainer: Josh Errickson
  • License: MIT + file LICENSE
  • Last published: 2024-09-19