optmatch: Functions for Optimal Matching

Distance based bipartite matching using the RELAX-IV minimum cost flow solver, oriented to matching of treatment and control groups in observational studies. 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.

AuthorBen B. Hansen <ben.hansen@umich.edu>, Mark Fredrickson <mark.m.fredrickson@gmail.com>, Josh Buckner, Josh Errickson, and Peter Solenberger, with embedded Fortran code due to Dimitri P. Bertsekas <dimitrib@mit.edu> and Paul Tseng
Date of publication2016-12-30 00:13:46
MaintainerMark M. Fredrickson <mark.m.fredrickson@gmail.com>
Licensefile LICENSE
Version0.9-7
https://www.r-project.org, https://github.com/markmfredrickson/optmatch

View on CRAN

Man pages

antiExactMatch: Specify a matching problem where units in a common factor...

as.InfinitySparseMatrix: Convert an object to InfinitySparseMatrix

caliper-methods: Prepare matching distances suitable for matching within...

caliperSize: (Internal) Determines how many other units fall within a...

caliperUpperBound: (Internal) Returns a reasonable upper bound on the arcs...

cbindrbind: Combine InfinitySparseMatrices or...

compare_optmatch: Compares the equality of optmatch objects, ignoring...

dimnames-InfinitySparseMatrix: Get and set dimnames for InfinitySparseMatrix objects

dist_digest: (Internal) Remove the call before digesting a distance so...

distUnion: Combine multiple distance specifications into a single...

effectiveSampleSize: Compute the effective sample size of a match.

exactMatch: Generate an exact matching set of subproblems.

fill.NAs: Create missingness indicator variables and non-informatively...

fmla2treatedblocking: (Internal) A helper function to turn formulas into treatment...

fullmatch: Optimal full matching

getMaxProblemSize: What is the maximum allowed problem size?

InfinitySparseMatrix-class: Objects for sparse matching problems.

ismBinaryOps: Element-wise addition

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

matched: Identification of units placed into matched sets

matched.distances: Determine distances between matched units

match_on-methods: Create treated to control distances for matching problems

maxCaliper: Find the maximum caliper width that will create a feasible...

mdist: (Deprecated, in favor of 'match_on') Create matching...

minExactMatch: Find the minimal exact match factors that will be feasible...

minmaxctlcap: Set thinning and thickening caps for full matching

missing_x_msg: (Internal) If the x argument does not exist for match_on,...

nuclearplants: Nuclear Power Station Construction Data

num_eligible_matches-methods: Returns the number of eligible matches for the distance.

optmatch: Optmatch Class

optmatch-defunct: Functions deprecated or removed from optmatch

optmatch_restrictions: optmatch_restrictions

optmatch_same_distance: Checks if the distance 'newdist' is identical to the distance...

pairmatch: Optimal 1:1 and 1:k matching

plantdist: Dissimilarities of Some U.S. Nuclear Plants

predict.CBPS: (Internal) Predict for CBPS objects

print.optmatch: Printing 'optmatch' objects.

relaxinfo: Display license information about embedded code

scoreCaliper: (Internal) Helper function to create an InfinitySparseMatrix...

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

setFeasibilityConstants: (Internal) Sets up the default values for maximum feasible...

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.

stratumStructure: Return structure of matched sets

subdim-methods: Returns the dimension of each valid subproblem

subproblemSuccess: (Internal) Report successful subproblems.

subset.InfinitySparseMatrix: Subsetting for InfinitySparseMatrices

summary.ism: Summarize a distance matrix

update.optmatch: Performs an update on an 'optmatch' object.

validDistanceSpecification: (Internal) Validate that objects are valid distance...

Files in this package

optmatch
optmatch/inst
optmatch/inst/examples
optmatch/inst/examples/pairmatch.R
optmatch/inst/examples/print.optmatch.R
optmatch/inst/examples/match_on.R
optmatch/inst/examples/fullmatch.R
optmatch/inst/examples/antiExactMatch.R
optmatch/inst/examples/caliper.R
optmatch/inst/examples/makeInfinitySparseMatrix.R
optmatch/inst/CITATION
optmatch/inst/doc
optmatch/inst/doc/matching-from-foreign-software.pdf
optmatch/inst/doc/matching-from-foreign-software.R
optmatch/inst/doc/matching-from-foreign-software.Rmd
optmatch/inst/doc/fullmatch-vignette.Rmd
optmatch/inst/doc/fullmatch-vignette.R
optmatch/inst/doc/fullmatch-vignette.pdf
optmatch/tests
optmatch/tests/mahal-dist.R
optmatch/tests/exporting-methods.R
optmatch/tests/mahal-dist.Rout.save
optmatch/tests/testthat.R
optmatch/tests/testthat
optmatch/tests/testthat/test.pairmatch.old.R
optmatch/tests/testthat/test.fullmatch.old.R
optmatch/tests/testthat/test.summary.ism.R
optmatch/tests/testthat/test.utilities.R
optmatch/tests/testthat/test.SubDivStrat.R
optmatch/tests/testthat/test.scores.R
optmatch/tests/testthat/test.maxControlsCap.old.R
optmatch/tests/testthat/test.RItools.R
optmatch/tests/testthat/test.stratumStructure.R
optmatch/tests/testthat/test.feasible.R
optmatch/tests/testthat/test.compute_mahal.R
optmatch/tests/testthat/test.stratumStructure.old.R
optmatch/tests/testthat/test.exporting-methods.R
optmatch/tests/testthat/test.summary.optmatch.R
optmatch/tests/testthat/test.DistanceSpecification.R
optmatch/tests/testthat/test.CBPS.R
optmatch/tests/testthat/test.caliper.R
optmatch/tests/testthat/test.fill.NAs.R
optmatch/tests/testthat/test.makedist.R
optmatch/tests/testthat/test.exactMatch.R
optmatch/tests/testthat/test.mahal-dist.R
optmatch/tests/testthat/test.fullmatch.R
optmatch/tests/testthat/test.InfinitySparseMatrix.R
optmatch/tests/testthat/test.fullmatch.infeasible.recovery.R
optmatch/tests/testthat/test.Optmatch.R
optmatch/tests/testthat/test.summary.optmatch.old.R
optmatch/tests/testthat/test.pairmatch.R
optmatch/tests/testthat/test.mdist.old.R
optmatch/tests/testthat/test.match_on.R
optmatch/tests/testthat/test.distUnion.R
optmatch/tests/testthat/test.fmatch.R
optmatch/tests/testthat/wishlist.scores.R
optmatch/tests/testthat/test.rank.mahal.R
optmatch/tests/testthat/test.maxControlsCap.R
optmatch/tests/testthat/test.moremethods.optmatch.R
optmatch/tests/testthat/test.mdist.R
optmatch/src
optmatch/src/distances.h
optmatch/src/subsetInfSparseMatrix.h
optmatch/src/Makevars
optmatch/src/relax4s.f
optmatch/src/r_smahal.h
optmatch/src/smahal.h
optmatch/src/distances.cc
optmatch/src/relax4sold.f
optmatch/src/ism.h
optmatch/src/map.cc
optmatch/src/subsetInfSparseMatrix.cc
optmatch/src/map.h
optmatch/src/cuseful.h
optmatch/src/cuseful.cc
optmatch/src/RcppExports.cpp
optmatch/src/smahal.cc
optmatch/src/ism.cc
optmatch/src/r_smahal.cc
optmatch/NAMESPACE
optmatch/demo
optmatch/demo/optmatch.r
optmatch/demo/00Index
optmatch/NEWS
optmatch/data
optmatch/data/nuclearplants.rda
optmatch/data/plantdist.rda
optmatch/R
optmatch/R/max.controls.cap.R optmatch/R/summary.optmatch.R optmatch/R/matched.R optmatch/R/zzzDistanceSpecification.R optmatch/R/subDivStrat.R optmatch/R/fmatch.R optmatch/R/print.optmatch.dlist.R optmatch/R/relaxinfo.R optmatch/R/abs.optmatch.dlist.R optmatch/R/Optmatch-package.R optmatch/R/scores.R optmatch/R/exactMatch.R optmatch/R/utilities.R optmatch/R/makedist.R optmatch/R/data.R optmatch/R/matched.distances.R optmatch/R/mdist.R optmatch/R/pairmatch.R optmatch/R/matchfailed.R optmatch/R/print.optmatch.R optmatch/R/distUnion.R optmatch/R/RcppExports.R optmatch/R/deprecated.R optmatch/R/match_on.R optmatch/R/fullmatch.R optmatch/R/Optmatch.R optmatch/R/boxplotMethods.R optmatch/R/min.controls.cap.R optmatch/R/caliper.R optmatch/R/Ops.optmatch.dlist.R optmatch/R/feasible.R optmatch/R/summary.ism.R optmatch/R/stratumStructure.R optmatch/R/fill.NAs.R optmatch/R/zzz.R optmatch/R/InfinitySparseMatrix.R optmatch/R/DenseMatrix.R
optmatch/vignettes
optmatch/vignettes/matching-from-foreign-software.Rmd
optmatch/vignettes/fullmatch-vignette.Rmd
optmatch/vignettes/performance
optmatch/vignettes/performance/performance.Rnw
optmatch/vignettes/performance/scaling.R
optmatch/vignettes/performance/distance-sparse-caliper.R
optmatch/vignettes/performance/mdist.R
optmatch/vignettes/performance/setup.R
optmatch/vignettes/performance/matching.R
optmatch/vignettes/performance/distance.R
optmatch/README.md
optmatch/MD5
optmatch/build
optmatch/build/vignette.rds
optmatch/DESCRIPTION
optmatch/man
optmatch/man/sort.ism.Rd optmatch/man/makeOptmatch.Rd optmatch/man/subproblemSuccess.Rd optmatch/man/pairmatch.Rd optmatch/man/scores.Rd optmatch/man/fmla2treatedblocking.Rd optmatch/man/compare_optmatch.Rd optmatch/man/getMaxProblemSize.Rd optmatch/man/minExactMatch.Rd optmatch/man/minmaxctlcap.Rd optmatch/man/maxCaliper.Rd optmatch/man/plantdist.Rd optmatch/man/cbindrbind.Rd optmatch/man/exactMatch.Rd optmatch/man/caliperUpperBound.Rd optmatch/man/distUnion.Rd optmatch/man/show-InfinitySparseMatrix-method.Rd optmatch/man/num_eligible_matches-methods.Rd optmatch/man/matched.Rd optmatch/man/effectiveSampleSize.Rd optmatch/man/InfinitySparseMatrix-class.Rd optmatch/man/setFeasibilityConstants.Rd optmatch/man/missing_x_msg.Rd optmatch/man/optmatch_restrictions.Rd optmatch/man/dimnames-InfinitySparseMatrix.Rd optmatch/man/predict.CBPS.Rd optmatch/man/summary.ism.Rd optmatch/man/optmatch.Rd optmatch/man/optmatch_same_distance.Rd optmatch/man/subdim-methods.Rd optmatch/man/ismBinaryOps.Rd optmatch/man/update.optmatch.Rd optmatch/man/setTryRecovery.Rd optmatch/man/show-BlockedInfinitySparseMatrix-method.Rd optmatch/man/fullmatch.Rd optmatch/man/mdist.Rd optmatch/man/relaxinfo.Rd optmatch/man/caliperSize.Rd optmatch/man/subset.InfinitySparseMatrix.Rd optmatch/man/caliper-methods.Rd optmatch/man/stratumStructure.Rd optmatch/man/optmatch-defunct.Rd optmatch/man/nuclearplants.Rd optmatch/man/matched.distances.Rd optmatch/man/fill.NAs.Rd optmatch/man/print.optmatch.Rd optmatch/man/scoreCaliper.Rd optmatch/man/match_on-methods.Rd optmatch/man/dist_digest.Rd optmatch/man/validDistanceSpecification.Rd optmatch/man/as.InfinitySparseMatrix.Rd optmatch/man/antiExactMatch.Rd
optmatch/LICENSE

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.