# Functions for Optimal Matching

## Documentation for package ‘optmatch’ version 0.9-7

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.
- Package NEWS.

## Help Pages

A C D E F G I M N O P R S U V misc

## -- A --

antiExactMatch | Specify a matching problem where units in a common factor cannot be matched.
as.InfinitySparseMatrix | Convert an object to InfinitySparseMatrix

## -- C --

caliper | Prepare matching distances suitable for matching within calipers.
caliper-method | Prepare matching distances suitable for matching within calipers.
caliperSize | (Internal) Determines how many other units fall within a caliper distance
caliperUpperBound | (Internal) Returns a reasonable upper bound on the arcs remaining after placing a caliper.
cbind.BlockedInfinitySparseMatrix | Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row or column
cbind.InfinitySparseMatrix | Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row or column
compare_optmatch | Compares the equality of optmatch objects, ignoring attributes and group names.

## -- D --

dimnames-method | Get and set dimnames for InfinitySparseMatrix objects
dimnames<--method | Get and set dimnames for InfinitySparseMatrix objects
distUnion | Combine multiple distance specifications into a single distance specification.
dist_digest | (Internal) Remove the call before digesting a distance so things like omitting caliper and calling caliper=NULL give the same digest #

## -- E --

effectiveSampleSize | Compute the effective sample size of a match.
effectiveSampleSize.default | Compute the effective sample size of a match.
effectiveSampleSize.factor | Compute the effective sample size of a match.
effectiveSampleSize.table | Compute the effective sample size of a match.
exactMatch | Generate an exact matching set of subproblems.
exactMatch-method | Generate an exact matching set of subproblems.

## -- F --

fill.NAs | Create missingness indicator variables and non-informatively fill in missing values
fmla2treatedblocking | (Internal) A helper function to turn formulas into treatment and blocking variables
full | Optimal full matching
fullmatch | Optimal full matching

## -- G --

getMaxProblemSize | What is the maximum allowed problem size?

## -- I --

InfinitySparseMatrix-class | Objects for sparse matching problems.

## -- M --

mahal.dist | Functions deprecated or removed from optmatch
makeOptmatch | (Internal) Create 'optmatch' objects, the result of matching.
matched | Identification of units placed into matched sets
matched.distances | Determine distances between matched units
matchfailed | Identification of units placed into matched sets
match_on | Create treated to control distances for matching problems
match_on.bigglm | Create treated to control distances for matching problems
match_on.formula | Create treated to control distances for matching problems
match_on.function | Create treated to control distances for matching problems
match_on.glm | Create treated to control distances for matching problems
match_on.InfinitySparseMatrix | Create treated to control distances for matching problems
match_on.matrix | Create treated to control distances for matching problems
match_on.numeric | Create treated to control distances for matching problems
maxCaliper | Find the maximum caliper width that will create a feasible problem.
maxControlsCap | Set thinning and thickening caps for full matching
mdist | (Deprecated, in favor of 'match_on') Create matching distances
mdist.bigglm | (Deprecated, in favor of 'match_on') Create matching distances
mdist.formula | (Deprecated, in favor of 'match_on') Create matching distances
mdist.function | (Deprecated, in favor of 'match_on') Create matching distances
mdist.glm | (Deprecated, in favor of 'match_on') Create matching distances
mdist.numeric | (Deprecated, in favor of 'match_on') Create matching distances
mdist.optmatch.dlist | (Deprecated, in favor of 'match_on') Create matching distances
minControlsCap | Set thinning and thickening caps for full matching
minExactMatch | Find the minimal exact match factors that will be feasible for a given maximum problem size.
missing_x_msg | (Internal) If the x argument does not exist for match_on, fullmatch, or pairmatch, use this function to print a helpful message.

## -- N --

nuclearplants | Nuclear Power Station Construction Data
num_eligible_matches | Returns the number of eligible matches for the distance.
num_eligible_matches.BlockedInfinitySparseMatrix | Returns the number of eligible matches for the distance.
num_eligible_matches.InfinitySparseMatrix | Returns the number of eligible matches for the distance.
num_eligible_matches.matrix | Returns the number of eligible matches for the distance.
num_eligible_matches.optmatch.dlist | Returns the number of eligible matches for the distance.

## -- O --

optmatch | Optmatch Class
optmatch-class | 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 used to generate the optmatch object 'obj'.

## -- P --

pair | Optimal 1:1 and 1:k matching
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.
print.stratumStructure | Return structure of matched sets
pscore.dist | Functions deprecated or removed from optmatch

## -- R --

rbind.BlockedInfinitySparseMatrix | Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row or column
rbind.InfinitySparseMatrix | Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row or column
relaxinfo | Display license information about embedded code

## -- S --

scoreCaliper | (Internal) Helper function to create an InfinitySparseMatrix from a set of scores, a treatment indicator, and a caliper width.
scores | Extract scores (propensity, prognostic,...) from a fitted model
setFeasibilityConstants | (Internal) Sets up the default values for maximum feasible problems
setTryRecovery | (Internal) Sets up option to try recovery in 'fullmatch'.
show-method | Displays a BlockedInfinitySparseMatrix
show-method | Displays an InfinitySparseMatrix
sort.BlockedInfinitySparseMatrix | Sort the internal structure of an InfinitySparseMatrix.
sort.InfinitySparseMatrix | Sort the internal structure of an InfinitySparseMatrix.
stratumStructure | Return structure of matched sets
stratumStructure.default | Return structure of matched sets
stratumStructure.optmatch | Return structure of matched sets
subdim | Returns the dimension of each valid subproblem
subdim.BlockedInfinitySparseMatrix | Returns the dimension of each valid subproblem
subdim.InfinitySparseMatrix | Returns the dimension of each valid subproblem
subdim.matrix | Returns the dimension of each valid subproblem
subdim.optmatch.dlist | Returns the dimension of each valid subproblem
subproblemSuccess | (Internal) Report successful subproblems.
subset.InfinitySparseMatrix | Subsetting for InfinitySparseMatrices
summary.BlockedInfinitySparseMatrix | Summarize a distance matrix
summary.DenseMatrix | Summarize a distance matrix
summary.InfinitySparseMatrix | Summarize a distance matrix
summary.ism | Summarize a distance matrix
summary.optmatch | Optmatch Class

## -- U --

unmatched | Identification of units placed into matched sets
update.optmatch | Performs an update on an 'optmatch' object.

## -- V --

validDistanceSpecification | (Internal) Validate that objects are valid distance specifications.

## -- misc --

*-method | Element-wise addition
+-method | Element-wise addition
--method | Element-wise addition
/-method | Element-wise addition