Function reference • optmatch

All functions

BlockedInfinitySparseMatrix-class: Blocked Infinity Sparse Matrix

InfinitySparseMatrix-class: Objects for sparse matching problems.

LEMON(): (Internal) Helper function for accessing algorithms in LEMON solver

antiExactMatch(): Specify a matching problem where units in a common factor cannot be matched.

as.InfinitySparseMatrix(): Convert an object to InfinitySparseMatrix

as.list(<BlockedInfinitySparseMatrix>): Splits a BlockedInfinitySparseMatrix into a list of InfinitySparseMatrices

c(<optmatch>): Combine Optmatch objects

caliper(): Prepare matching distances suitable for matching within calipers.

cbind(<InfinitySparseMatrix>) rbind(<InfinitySparseMatrix>) cbind(<BlockedInfinitySparseMatrix>) rbind(<BlockedInfinitySparseMatrix>): Combine InfinitySparseMatrices or BlockedInfinitySparseMatrices by row or column

compare_optmatch(): Compares the equality of optmatch objects, ignoring attributes and group names.

dbind(): Diagonally bind together subgroup-specific distances

dimnames,InfinitySparseMatrix-method dimnames dimnames: Get and set dimnames for InfinitySparseMatrix objects

distUnion(): Combine multiple distance specifications into a single distance specification.

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 missing values

findSubproblems(): List subproblems of a distance

fullmatch() full(): Optimal full matching

getMaxProblemSize(): What is the maximum allowed problem size?

subset(<InfinitySparseMatrix>) `[`(<InfinitySparseMatrix>) `[<-`(<InfinitySparseMatrix>): Subsetting for InfinitySparseMatrices

`+`(<InfinitySparseMatrix>,<InfinitySparseMatrix>) `-`(<InfinitySparseMatrix>,<InfinitySparseMatrix>) `*`(<InfinitySparseMatrix>,<InfinitySparseMatrix>) `/`(<InfinitySparseMatrix>,<InfinitySparseMatrix>): Element-wise addition

match_on match_on.glm match_on.bigglm match_on.formula match_on.function match_on.numeric match_on.InfinitySparseMatrix match_on.matrix: Create treated to control distances for matching problems

matched() unmatched() matchfailed(): Identification of units placed into matched sets

matched.distances(): Determine distances between matched units

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

c(<SubProbInfo>) c(<NodeInfo>) c(<ArcInfo>) c(<MCFSolutions>) c(<FullmatchMCFSolutions>): Combine objects

mdist mdist.optmatch.dlist mdist.function mdist.formula mdist.glm mdist.bigglm mdist.numeric: (Deprecated, in favor of match_on) Create matching distances

minExactMatch(): Find the minimal exact match factors that will be feasible for a given maximum problem size.

maxControlsCap() minControlsCap(): Set thinning and thickening caps for full matching

nuclearplants: Nuclear Power Station Construction Data

num_eligible_matches(): Returns the number of eligible matches for the distance.

pscore.dist() mahal.dist(): Functions deprecated or removed from optmatch

summary(<optmatch>): Optmatch Class

optmatch_restrictions(): optmatch_restrictions

optmatch_same_distance(): Checks if two distances are equivalent. x and y can be distances (InfinitySparseMatrix, BlockedInfinitySparseMatrix, or DenseMatrix), or they can be optmatch objects.

pairmatch() pair(): 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.

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

setMaxProblemSize(): Set the maximum problem size

show(<BlockedInfinitySparseMatrix>): Displays a BlockedInfinitySparseMatrix

show(<InfinitySparseMatrix>): Displays an InfinitySparseMatrix

sort(<InfinitySparseMatrix>) sort(<BlockedInfinitySparseMatrix>): Sort the internal structure of an InfinitySparseMatrix.

strata(): Identify Stratafication Variables

stratumStructure() print(<stratumStructure>): Return structure of matched sets

subdim(): Returns the dimension of each valid subproblem

summary(<InfinitySparseMatrix>) summary(<BlockedInfinitySparseMatrix>) summary(<DenseMatrix>): Summarize a distance matrix

update(<optmatch>): Performs an update on an optmatch object.