sgkit-dev / sgkit

Scalable genetics toolkit
https://sgkit-dev.github.io/sgkit
Apache License 2.0
227 stars 32 forks source link

Update `pedigree_kinship` API to match `hybrid_relationship` #1061

Closed timothymillar closed 1 year ago

timothymillar commented 1 year ago

This only concerns the founder_kinship parameter. This is an optional sub-matrix which is used to initialize the estimate. Currently this is expected to have different dimensions to the output matrix (samples * samples). This should probably be updated to follow the hybrid_relationship API in which a full-sized NaN-padded matrix is used.

timothymillar commented 1 year ago

We could do this by deprecating the old API, rather than an immediate breaking change.

Old API:

So