The function idcoefs()
was removed, since it relied on the no-longer-available package identity
.
The deprecated kinshipX()
, inbreedingX()
and kappaIbdX()
were removed, and replaced with an argument Xchrom
in kinship()
, inbreeding()
and kappaIBD()
.
The function generalisedKinship()
has been replaced with the much more versatile gKinship()
(see below).
New function identityCoefs()
for computing condensed and detailed identity coefficients (“Jacquard coefficients”). Both autosomal and X-chromosomal versions are supported. This function supersedes condensedIdentity()
and condensedIdentityX()
, which will continue to exist, nonetheless.
condensedIdentity()
gains arguments simplify
and self
, to match the new identityCoefs()
.
Computation of identity coefficients by MERLIN (via the “–extended” feature) is implemented in identityCoefs()
with the option method = "merlin"
. Note that MERLIN rounds the output to 3 decimals, reducing its utility somewhat.
New function gKinship()
for computing generalised kinship coefficients. Several algorithms are implemented, supporting various flavours (random vs. deterministic; distinct vs. non-distinct groups; autosomal vs. X).
New container class gip
for generalised IBD patterns. Includes a print method.
New function coeffTable()
collecting various pedigree coefficients in a single table.
New function kin2deg()
computing the degree of relatedness, as used e.g. by the software KING.
kinship(x, ids)
affecting pedigrees in nonstandard order.kinship()
now accepts a list of pedigrees as input.The README has been rewritten and substantially expanded.
kappaIBD()
now accepts ped lists as input.
In inbreeding()
the argument id
is renamed to ids
and accepts vectors of length > 1.
New function ibdDraw()
for illustrating IBD patterns in a pedigree. IBD alleles are represented as coloured dots or as letters.
New function ibdTriangle()
, which replaces forrel::IBDtriangle()
.
constructPedigree()
now gives a textual description of the (usually double-half-cousin-like) pedigree it produces.
New function constructPedigree()
, which constructs a pedigree yielding a prescribed set of IBD coefficients. This implements the algorithm described in https://doi.org/10.1007/s00285-020-01505-x.
kinship()
gains a new argument ids
, which is handy when you only want the kinship coefficient between two individuals (and not the whole kinship matrix)
Similarly, inbreeding()
gains the argument id
for computing the inbreeding coefficient of a single individual.