ExtractPairsOfInterest: Extract pairs of interest

View source: R/PopSims.R

ExtractPairsOfInterestR Documentation

Extract pairs of interest

Description

A helper function to extract kinships of specific pairs of individuals.

Usage

ExtractPairsOfInterest(kinships, PairsOfInterest)

Arguments

kinships

A data frame with at least two columns: ind1 and ind2

PairsOfInterest

A data frame describing focal relationships. All ids in ind1 and ind2 should be found in kinships (the order is not important). Report all if none provided. See PairsOfInterest.

Value

Reduced data frame of Kinship.

Examples

ancestrygenomatrix<-PopulationSim(1000,c(0.05,0.15,0.25))
ancestry<-matrix(c(6,2,0.3,2,6,0.3),nrow=3)
kins<-HapdipPedigreeSim(ancestrygenomatrix,pedigree,ancestry)
ExtractPairsOfInterest(kins,PairsOfInterest)

YenWenWang/HapDipKinship documentation built on Jan. 20, 2025, 10:09 a.m.