findRelated {BGData} | R Documentation |
Find related individuals in a relationship matrix
Description
Find related individuals in a relationship matrix.
Usage
findRelated(x, ...)
## S3 method for class 'matrix'
findRelated(x, cutoff = 0.03, ...)
## S3 method for class '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 |
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
# Load example data
bg <- BGData:::loadExample()
G <- getG(geno(bg))
findRelated(G)
[Package BGData version 2.4.1 Index]