summary.fastLink: Get summaries of fastLink() objects

View source: R/summary.R

summary.fastLinkR Documentation

Get summaries of fastLink() objects

Description

summary.fastLink() calculates and outputs FDR, FNR, match counts, and match rates for estimated matches from a fastLink() object.

Usage

## S3 method for class 'fastLink'
summary(object, num.comparisons = 1,
thresholds = c(.95, .85, .75), weighted = TRUE, digits = 3, ...)

Arguments

object

Either a single 'fastLink' or 'fastLink.EM' object, or a list of 'fastLink' or 'fastLink.EM' objects to be aggregated together produced by 'aggregateEM'.

num.comparisons

The number of comparisons attempted for each observation in the across-geography match step. A correction factor to avoid multiple-counting. Default is NULL

thresholds

A vector of posterior probabilities to calculate the summary statistics.

weighted

Whether to weight the cross-geography matches on FDR and FNR.

digits

How many digits to include in summary object. Default is 3.

...

Further arguments to be passed to summary.fastLink().


kosukeimai/fastLink documentation built on Nov. 17, 2023, 8:11 p.m.