optmatch: Functions for Optimal Matching
Version 0.9-7

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
URL https://www.r-project.org https://github.com/markmfredrickson/optmatch
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("optmatch")

Getting started

README.md
Matching in *R* using the `optmatch` and `RItools` packages
Using Optmatch on data in SAS, Stata, etc

Popular man pages

caliperUpperBound: (Internal) Returns a reasonable upper bound on the arcs...
fullmatch: Optimal full matching
getMaxProblemSize: What is the maximum allowed problem size?
match_on-methods: Create treated to control distances for matching problems
missing_x_msg: (Internal) If the x argument does not exist for match_on,...
pairmatch: Optimal 1:1 and 1:k matching
stratumStructure: Return structure of matched sets
See all...

All man pages Function index File listing

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...

Functions

Files

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

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

Please suggest features or report bugs in the GitHub issue tracker.

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