scoreFamilies: Calculate match score generic.

Description Usage Arguments Value

View source: R/scoreFamilies.R

Description

scoreFamilies returns a Scores object with the Neighbors slot populated with a match score for each potential duplicate found from the BSN algorithm. A match score is calculated by averaging the number of string/binary variable matches consistent between the two records plus a similarity measure for the continuous variables.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
scoreFamilies(object, familyDat, selfID, motherID, fatherID)

## Default S3 method:
scoreFamilies(object, familyDat, selfID, motherID, fatherID)

## S3 method for class 'Blocks'
scoreFamilies(object, familyDat, selfID, motherID, fatherID)

## S3 method for class 'Scores'
scoreFamilies(object, familyDat, selfID, motherID, fatherID)

Arguments

object

object containing pre-computed Neighbors from the BSN algorithm.

familyDat

data matrix containing family data so score.

selfID

character referencing the column in familyDat which points to a self's ID.

motherID

character referencing the column in familyDat which points to a self's mother's ID

fatherID

character referencing the column in familyDat which points to a self's father's ID

Value

An object of class Scores containing the scored neighbor pairs.


mPloenzke/bsnR documentation built on June 30, 2018, 9:11 a.m.