summary: Print Summary of Record Linkage Data

summaryR Documentation

Print Summary of Record Linkage Data

Description

Prints information on RecLinkData and "RecLinkResult" objects.

Usage

## S3 method for class 'RecLinkData'
summary(object,...)

## S3 method for class 'RecLinkResult'
summary(object,...)

Arguments

object

The object for which to print a summary.

...

Additional arguments from the generic, silently ignored.

Details

The printed information for RecLinkData objects includes:

  • The number of records.

  • The number of record pairs.

  • The number of true matches, true non-matches and pairs with unknown status.

  • If weights have been calculated for this object, a textual histogram of the weight distribution.

Information on "RecLinkResult" objects includes all of the above and the following:

  • The number of detected links, non-links and possible links.

  • The following error measures, if the true matching status of all record pairs is known: Alpha error (ratio of false links to matches), beta error (ratio of false non-links to non-matches) and accuracy (ratio of correctly classified pairs to the total number of pairs).

  • A cross-classified table counting true matching status against classification. The true matching status is represented as logical values, possibly including NA for unknown status. Classification results are represented by:

    "L"

    for links,

    "P"

    for possible links

    "N"

    for non-links

Value

Returns an invisible NULL and is used for its side effect.

Author(s)

Andreas Borg

See Also

RecLinkData,"RecLinkResult"


RecordLinkage documentation built on Nov. 10, 2022, 5:42 p.m.