# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "couplr" in publications use:'
type: software
license: MIT
title: 'couplr: Optimal Pairing and Matching via Linear Assignment'
version: 1.4.1
identifiers:
- type: doi
  value: 10.32614/CRAN.package.couplr
abstract: Solves optimal pairing and matching problems using linear assignment algorithms.
  Provides implementations of the Hungarian method (Kuhn 1955) <https://doi.org/10.1002/nav.3800020109>,
  Jonker-Volgenant shortest path algorithm (Jonker and Volgenant 1987) <https://doi.org/10.1007/BF02278710>,
  Auction algorithm (Bertsekas 1988) <https://doi.org/10.1007/BF02186476>, cost-scaling
  (Goldberg and Kennedy 1995) <https://doi.org/10.1007/BF01585996>, scaling algorithms
  (Gabow and Tarjan 1989) <https://doi.org/10.1137/0218069>, push-relabel (Goldberg
  and Tarjan 1988) <https://doi.org/10.1145/48014.61051>, and Sinkhorn entropy-regularized
  transport (Cuturi 2013) <https://doi.org/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.
authors:
- family-names: Colling
  given-names: Gilles
  email: gilles.colling051@gmail.com
  orcid: https://orcid.org/0000-0003-3070-6066
preferred-citation:
  type: manual
  title: 'couplr: Optimal Pairing and Matching via Linear Assignment'
  authors:
  - family-names: Colling
    given-names: Gilles
    email: gilles.colling051@gmail.com
    orcid: https://orcid.org/0000-0003-3070-6066
  year: '2026'
  notes: R package version 1.4.0
  url: https://github.com/gcol33/couplr
repository: https://gcol33.r-universe.dev
repository-code: https://github.com/gcol33/couplr
commit: bd4a14367eefdea77b874cc8bb83473191809580
url: https://gillescolling.com/couplr/
date-released: '2026-05-29'
contact:
- family-names: Colling
  given-names: Gilles
  email: gilles.colling051@gmail.com
  orcid: https://orcid.org/0000-0003-3070-6066