Functions for optimal matching


[Up] [Top]

Documentation for package ‘optmatch’ version 0.9-3

Help Pages

antiExactMatch Specify a matching problem where units in a common factor cannot be matched.
as.InfinitySparseMatrix (Internal) Creating sparse matching problems
BlockedInfinitySparseMatrix-class Generate an exact matching set of subproblems
caliper Prepare matching distances suitable for matching within calipers.
caliper-method Prepare matching distances suitable for matching within calipers.
caliper-methods 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.
compare_optmatch Compares the equality of optmatch objects, ignoring attributes and group names.
dimnames-method (Internal) Creating sparse matching problems
dimnames<--method (Internal) Creating sparse matching problems
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
effectiveSampleSize 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
exactMatch-methods Generate an exact matching set of subproblems
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
getMaxProblemSize (Internal) What is the maximum allowed problem size?
InfinitySparseMatrix-class Create treated to control distances for matching problems
mahal.dist Functions deprecated or removed from optmatch
makeInfinitySparseMatrix (Internal) Creating sparse matching problems
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
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.
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.
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'.
pair Optimal 1:1 and 1:k matching
pairmatch Optimal 1:1 and 1:k matching
plantdist Dissimilarities of Some U.S. Nuclear Plants
print.optmatch Printing 'optmatch' objects.
pscore.dist Functions deprecated or removed from optmatch
relaxinfo Display license information about embedded code
scoreCaliper (Internal) Helper function to create an InfinitySparseMatrix from a set of scores, a treatment indicator, and a caliper width.
scores Wrapper for 'predict' to cleanly look for new data to predict on.
setFeasibilityConstants (Internal) Sets up the default values for maximum feasible problems
setTryRecovery (Internal) Sets up option to try recovery in 'fullmatch'.
stratumStructure 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.
summary.optmatch Optmatch Class
unmatched Identification of units placed into matched sets
update.optmatch Performs an update on an 'optmatch' object.
validDistanceSpecification (Internal) Validate that objects are valid distance specifications.