deDuplicate: deDuplicate scored neighbors matrix.

Description Usage Arguments Value

View source: R/deDuplicate.R

Description

Outputs the Duplicates object, providing the duplicate entities and the representatives for each duplicate entity.

Usage

1
2
3
4
5
6
7
deDuplicate(object, thresh, priority, isProband, dateFormat = NULL, requestID)

## Default S3 method:
deDuplicate(object, thresh, priority, isProband, dateFormat = NULL, requestID)

## S3 method for class 'Scores'
deDuplicate(object, thresh, priority, isProband, dateFormat = NULL, requestID)

Arguments

object

Scores object containing pre-computed Neighbors and match scores.

thresh

Vector of thresholds at which to classify scores as duplicates. These can either be integers from 1 to 7 (for the intersection score) or numbers between 0 and 1, representing quantiles (for the greedy match score).

priority

A list of structure (var = 'Varx', min = TRUE) with 'Varx' being a character value corresponding to a column in rawData. This parameter determines how to sort the duplicates. If min = TRUE, then we use the minimum value of 'Varx' for each duplicate entity. Otherwise, we use the maximum value.

isProband

A character value indicating the column indicator column that denotes the proband.

dateFormat

Character string of the format of the date. This is only used if the priority variable is a date. The format should match the formats of class POSIXlt used in the base::strptime function.

requestID

Column that has the ID for the family.

Value

An object of class Duplicates containing the duplicate entities and representatives for each duplicate entity (including singletons without duplicates).


bayesmendel/snipR documentation built on Jan. 25, 2022, 12:33 a.m.