Optimal Pairing and Matching via Linear Assignment

Documentation for package ‘couplr’ version 1.9.0

Help Pages

-- A --

animated_methods	List Methods That Support Animation
as.data.frame.assignment_duals_result	Solve an Assignment Problem and Return Dual Potentials
as.data.frame.couplr_path	Solve a Sequence of Matchings over One Design Parameter
as.data.frame.couplr_result	Matching Results
as.data.frame.sensitivity_analysis	Rosenbaum Sensitivity Analysis
as.matrix.distance_object	Compute and Cache a Distance Matrix
as.matrix.sinkhorn_result	Entropic Optimal Transport by Sinkhorn-Knopp Iteration
assignment	Solve a Linear Assignment Problem
assignment_duals	Solve an Assignment Problem and Return Dual Potentials
as_assignment_matrix	Convert an Assignment Result to a Binary Matrix
as_matchit	Convert a Matching Result to a matchit Object
augment.couplr_result	Join Matched Pairs with the Original Data
autoplot.balance_diagnostics	Balance Diagnostics for Matched Samples
autoplot.matching_result	Matching Results
autoplot.sensitivity_analysis	Rosenbaum Sensitivity Analysis

-- B --

bal.tab.couplr_result	Balance Tables from cobalt for Matching Results
bal.tab.subclass_result	Balance Tables from cobalt for Matching Results
balance_diagnostics	Balance Diagnostics for Matched Samples
balance_diagnostics.cem_result	Balance Diagnostics for Matched Samples
balance_diagnostics.full_matching_result	Balance Diagnostics for Matched Samples
balance_diagnostics.matching_result	Balance Diagnostics for Matched Samples
balance_diagnostics.subclass_result	Balance Diagnostics for Matched Samples
balance_table	Balance Table of a Balance Diagnostics Object
bottleneck_assignment	Solve the Bottleneck Assignment Problem

-- C --

cardinality_match	Cardinality Matching
cem_match	Coarsened Exact Matching
certificate	Certificate, Potentials and Unmatched Units of a Result
compute_distances	Compute and Cache a Distance Matrix
couplr_result	Matching Results

-- D --

diagnose_distance_matrix

Diagnose a Distance Matrix

-- E --

estimate_dense_matrix_mb	Estimate the Memory of a Dense Cost Matrix
estimate_dense_solve_mb	Estimate the Peak Memory of a Dense Solve
example_costs	Example Cost Matrices
example_df	Example Assignment Data Frame
explain_dispatch	Explain the Automatic Solver Choice

-- F --

full_match

Full Matching

-- G --

get_method_used	Solve a Linear Assignment Problem
get_total_cost	Solve a Linear Assignment Problem
glance.assignment_certificate	Certificate, Potentials and Unmatched Units of a Result
glance.cardinality_certificate	Certificate, Potentials and Unmatched Units of a Result
glance.couplr_result	Matching Results
glance.flow_certificate	Certificate, Potentials and Unmatched Units of a Result

-- H --

hospital_staff

Hospital Staff Example Data

-- I --

is_distance_object	Compute and Cache a Distance Matrix
is_lap_solve_batch_result	Solve Many Assignment Problems
is_lap_solve_kbest_result	Find the k Best Assignments
is_lap_solve_result	Solve a Linear Assignment Problem

-- J --

join_matched	Join Matched Pairs with the Original Data
join_matched.cem_result	Join Matched Pairs with the Original Data
join_matched.full_matching_result	Join Matched Pairs with the Original Data
join_matched.matching_result	Join Matched Pairs with the Original Data
join_matched.subclass_result	Join Matched Pairs with the Original Data

-- L --

lap_animate	Animate an Assignment Algorithm
lap_solve	Solve Linear Assignment Problems with a Tidy Interface
lap_solvers	Assignment Solvers
lap_solve_batch	Solve Many Assignment Problems
lap_solve_kbest	Find the k Best Assignments
lap_solve_line_metric	Solve a One-Dimensional Assignment Problem

-- M --

matchmaker	Create Blocks for Stratified Matching
match_couples	Optimal and Greedy Pair Matching
match_data	Extract Analysis-Ready Data from a Matching Result
match_data.cem_result	Extract Analysis-Ready Data from a Matching Result
match_data.full_matching_result	Extract Analysis-Ready Data from a Matching Result
match_data.matching_result	Extract Analysis-Ready Data from a Matching Result
match_data.subclass_result	Extract Analysis-Ready Data from a Matching Result
match_path	Solve a Sequence of Matchings over One Design Parameter

-- P --

pixel_morph	Pixel-Level Image Morphing
pixel_morph_animate	Animated Pixel-Level Image Morphing
plot.balance_diagnostics	Balance Diagnostics for Matched Samples
plot.couplr_path	Solve a Sequence of Matchings over One Design Parameter
plot.matching_result	Matching Results
plot.sensitivity_analysis	Rosenbaum Sensitivity Analysis
potentials	Certificate, Potentials and Unmatched Units of a Result
preprocess_matching_vars	Check Matching Variables and Choose Scaling
print.assignment_certificate	Verify That an Assignment Is Optimal
print.assignment_duals_result	Solve an Assignment Problem and Return Dual Potentials
print.balance_diagnostics	Balance Diagnostics for Matched Samples
print.cardinality_certificate	Certificate, Potentials and Unmatched Units of a Result
print.couplr_path	Solve a Sequence of Matchings over One Design Parameter
print.couplr_result	Matching Results
print.dispatch_explanation	Explain the Automatic Solver Choice
print.distance_diagnostics	Diagnose a Distance Matrix
print.distance_object	Compute and Cache a Distance Matrix
print.flow_certificate	Verify That a Flow Is Optimal
print.lap_solve_batch_result	Solve Many Assignment Problems
print.lap_solve_kbest_result	Find the k Best Assignments
print.lap_solve_result	Solve a Linear Assignment Problem
print.matchmaker_result	Create Blocks for Stratified Matching
print.pixel_morph_animation	Animated Pixel-Level Image Morphing
print.preprocessing_result	Check Matching Variables and Choose Scaling
print.sensitivity_analysis	Rosenbaum Sensitivity Analysis
print.sinkhorn_result	Entropic Optimal Transport by Sinkhorn-Knopp Iteration
print.variable_health	Check Matching Variables and Choose Scaling
ps_match	Propensity Score Matching

-- R --

register_lap_solver	Assignment Solvers
result_accessors	Certificate, Potentials and Unmatched Units of a Result

-- S --

sensitivity_analysis	Rosenbaum Sensitivity Analysis
sinkhorn	Entropic Optimal Transport by Sinkhorn-Knopp Iteration
sinkhorn_to_assignment	Round a Sinkhorn Transport Plan to an Assignment
solver_status_values	Solver Status Values
subclass_match	Subclassification on Propensity Score
summary.assignment_certificate	Verify That an Assignment Is Optimal
summary.assignment_duals_result	Solve an Assignment Problem and Return Dual Potentials
summary.balance_diagnostics	Balance Diagnostics for Matched Samples
summary.bottleneck_result	Solve the Bottleneck Assignment Problem
summary.cardinality_certificate	Certificate, Potentials and Unmatched Units of a Result
summary.couplr_path	Solve a Sequence of Matchings over One Design Parameter
summary.couplr_result	Matching Results
summary.dispatch_explanation	Explain the Automatic Solver Choice
summary.distance_diagnostics	Diagnose a Distance Matrix
summary.distance_object	Compute and Cache a Distance Matrix
summary.flow_certificate	Verify That a Flow Is Optimal
summary.lap_line_metric_result	Solve a One-Dimensional Assignment Problem
summary.lap_solve_batch_result	Solve Many Assignment Problems
summary.lap_solve_kbest_result	Find the k Best Assignments
summary.lap_solve_result	Solve a Linear Assignment Problem
summary.matchmaker_result	Create Blocks for Stratified Matching
summary.pixel_morph_animation	Animated Pixel-Level Image Morphing
summary.preprocessing_result	Check Matching Variables and Choose Scaling
summary.sensitivity_analysis	Rosenbaum Sensitivity Analysis
summary.sinkhorn_result	Entropic Optimal Transport by Sinkhorn-Knopp Iteration
summary.variable_health	Check Matching Variables and Choose Scaling

-- T --

tidy.couplr_result

Matching Results

-- U --

unmatched_units	Certificate, Potentials and Unmatched Units of a Result
update_constraints	Update the Constraints of a Distance Object

-- V --

verify_assignment	Verify That an Assignment Is Optimal
verify_flow	Verify That a Flow Is Optimal