couplr: Optimal Pairing and Matching via Linear Assignment
Solves optimal pairing and matching problems using linear assignment algorithms. Provides implementations of the Hungarian method (Kuhn 1955) <doi:10.1002/nav.3800020109>, Jonker-Volgenant shortest path algorithm (Jonker and Volgenant 1987) <doi:10.1007/BF02278710>, Auction algorithm (Bertsekas 1988) <doi:10.1007/BF02186476>, cost-scaling (Goldberg and Kennedy 1995) <doi:10.1007/BF01585996>, scaling algorithms (Gabow and Tarjan 1989) <doi:10.1137/0218069>, push-relabel (Goldberg and Tarjan 1988) <doi:10.1145/48014.61051>, and Sinkhorn entropy-regularized transport (Cuturi 2013) <doi:10.48550/arxiv.1306.0895>. Designed for matching plots, sites, samples, or any pairwise optimization problem. Supports rectangular matrices, forbidden assignments, data frame inputs, batch solving, k-best solutions, and pixel-level image morphing for visualization. Includes automatic preprocessing with variable health checks, multiple scaling methods (standardized, range, robust), greedy matching algorithms, and comprehensive balance diagnostics for assessing match quality using standardized differences and distribution comparisons.
| Version: | 1.1.0 |
| Depends: | R (≥ 4.1.0) |
| Imports: | Rcpp (≥ 1.0.0), tibble (≥ 3.0.0), dplyr (≥ 1.0.0), rlang (≥ 0.4.0), purrr (≥ 0.3.0), methods |
| LinkingTo: | Rcpp, RcppEigen, testthat |
| Suggests: | testthat (≥ 3.0.0), xml2, e1071, R.utils, microbenchmark, withr, knitr, rmarkdown, bench, parallel, future (≥ 1.20.0), future.apply (≥ 1.8.0), ggplot2, ggraph, tidygraph, magick, OpenImageR, farver, av, reticulate, png, combinat |
| Published: | 2026-03-03 |
| DOI: | 10.32614/CRAN.package.couplr |
| Author: | Gilles Colling 
[aut, cre, cph] |
| Maintainer: | Gilles Colling <gilles.colling051 at gmail.com> |
| BugReports: | https://github.com/gcol33/couplr/issues |
| License: | MIT + file LICENSE |
| URL: | https://gillescolling.com/couplr/, https://github.com/gcol33/couplr |
| NeedsCompilation: | yes |
| SystemRequirements: | C++17 |
| Language: | en-US |
| Citation: | couplr citation info |
| Materials: | README, NEWS |
| CRAN checks: | couplr results |
Documentation:
| Reference manual: | couplr.html , couplr.pdf |
| Vignettes: |
The Algorithm Collection (source, R code) Comparison with Alternatives (source, R code) Quick Start (source, R code) Matching Workflows (source, R code) Advanced Topics (source, R code) Troubleshooting Guide (source, R code) |
Downloads:
| Package source: | couplr_1.1.0.tar.gz |
| Windows binaries: | r-devel: couplr_1.1.0.zip, r-release: couplr_1.1.0.zip, r-oldrel: not available |
| macOS binaries: | r-release (arm64): couplr_1.1.0.tgz, r-oldrel (arm64): couplr_1.1.0.tgz, r-release (x86_64): couplr_1.1.0.tgz, r-oldrel (x86_64): couplr_1.1.0.tgz |
| Old sources: | couplr archive |
Linking:
Please use the canonical form https://CRAN.R-project.org/package=couplr to link to this page.