Learn R
BGData (version 2.1.0)

findRelated: Find related individuals in a relationship matrix.

Description

Find related individuals in a relationship matrix.

Usage

findRelated(x, ...)
# S3 method for matrix
findRelated(x, cutoff = 0.03, ...)
# S3 method for symDMatrix
findRelated(x, cutoff = 0.03, verbose = FALSE,
  ...)

Arguments

x

A matrix-like object with dimnames.

...

Additional arguments for methods.

cutoff

The cutoff between 0 and 1 for related individuals to be included in the output. Defaults to 0.03.

verbose

Whether progress updates will be posted. Defaults to FALSE.

Value

A vector of names or indices of related individuals.

Methods (by class)

  • matrix: Find related individuals in matrices

  • symDMatrix: Find related individuals in symDMatrix objects

Examples

Run this code
# NOT RUN {
# Load example data
bg <- BGData:::loadExample()

G <- getG(bg@geno)
findRelated(G)
# }

Run the code above in your browser using DataCamp Workspace