indiv_inbreeding: Individual inbreeding coefficient

In tidypopgen: Tidy Population Genetics

Individual inbreeding coefficient

Description

This function calculates the inbreeding coefficient for each individual based on the beta estimate from Weir and Goudet (2017).

Usage

indiv_inbreeding(.x, method = c("WG17"), allele_sharing_mat = NULL, ...)

## S3 method for class 'tbl_df'
indiv_inbreeding(.x, method = c("WG17"), allele_sharing_mat = NULL, ...)

## S3 method for class 'vctrs_bigSNP'
indiv_inbreeding(.x, method = c("WG17"), allele_sharing_mat = NULL, ...)

## S3 method for class 'grouped_df'
indiv_inbreeding(.x, method = c("WG17"), allele_sharing_mat = NULL, ...)

Arguments

.x	a vector of class vctrs_bigSNP (usually the genotype column of a gen_tibble object), or a gen_tibble.
method	currently only "WG17" (for Weir and Goudet 2017).
allele_sharing_mat	optional and only relevant for "WG17", the matrix of Allele Sharing returned by pairwise_allele_sharing() with as_matrix=TRUE. As a number of statistics can be derived from the Allele Sharing matrix, it it sometimes more efficient to pre-compute this matrix. It is not possible to use this with grouped tibbles.
...	currently unused.

Value

a numeric vector of inbreeding coefficients.

Examples

example_gt <- load_example_gt("gen_tbl")

example_gt %>% indiv_inbreeding(method = "WG17")

tidypopgen documentation built on Aug. 28, 2025, 1:08 a.m.