# matched.distances: Determine distances between matched units In optmatch: Functions for Optimal Matching

 matched.distances R Documentation

## Determine distances between matched units

### Description

From a match (as produced by `pairmatch` or `fullmatch`) and a distance, extract the distances of matched units from their matched counterparts.

### Usage

``````matched.distances(matchobj, distance, preserve.unit.names = FALSE)
``````

### Arguments

 `matchobj` Value of a call to `pairmatch` or `fullmatch`. `distance` Either a distance matrix or the value of a call to or `match_on`. `preserve.unit.names` Logical. If TRUE, for each matched set `matched.distances` returns the submatrix of the distance matrix corresponding to it; if FALSE, a vector containing the distances in that submatrix is returned.

### Details

From a match (as produced by `pairmatch` or `fullmatch`) and a distance, extract the distances of matched units from their matched counterparts.

### Value

A list of numeric vectors (or matrices) of distances, one for each matched set. Note that a matched set with 1 treatment and k controls, or with k treatments and 1 control, has k, not k+1, distances.

Ben B. Hansen

### Examples

``````
data(plantdist)
plantsfm <- fullmatch(plantdist)
(plantsfm.d <- matched.distances(plantsfm,plantdist,pres=TRUE))
unlist(lapply(plantsfm.d, max))
mean(unlist(plantsfm.d))
``````

optmatch documentation built on Nov. 16, 2023, 5:06 p.m.