Learn R Programming

KDPS

KDPS (Kinship Decouple and Phenotype Selection) is an R package designed to resolve cryptic relatedness in genetic studies using a phenotype-aware approach. It retains subjects with relevant traits while pruning related individuals based on kinship or identity-by-descent (IBD) scores.

Features

  • Prioritizes individuals with key phenotypes (categorical or numeric)
  • Supports phenotype ranking and composite scoring
  • Customizable pruning using fuzziness parameter
  • Efficient on biobank-scale datasets like UK Biobank
  • Compatible with both kinship and phenotype file formats

Installation

You can install the development version of KDPS from GitHub with:

# install.packages("devtools")
devtools::install_github("UCSD-Salem-Lab/kdps")

Tutorial

You can view the tutorial of the KDPS function with:

vignette("kdps-intro", package = "kdps")

Example

library(kdps)

phenotype_file = system.file("extdata", "simple_pheno.txt", package = "kdps")
kinship_file   = system.file("extdata", "simple_kinship.txt", package = "kdps")

kdps_results = kdps(
  phenotype_file = phenotype_file,
  kinship_file = kinship_file,
  fuzziness = 0,
  phenotype_name = "pheno2",
  prioritize_high = FALSE,
  prioritize_low = FALSE,
  phenotype_rank = c("DISEASED1", "DISEASED2", "HEALTHY"),
  fid_name = "FID",
  iid_name = "IID",
  fid1_name = "FID1",
  iid1_name = "IID1",
  fid2_name = "FID2",
  iid2_name = "IID2",
  kinship_name = "KINSHIP",
  kinship_threshold = 0.0442,
  phenotypic_naive = FALSE
)

head(kdps_results)

Documentation

Citation

If you use KDPS in your research, please cite:

Wanjun Gu, Jiachen Xi, Steven Cao, Rany M. Salem. Kinship Decouple and Phenotype Selection (KDPS). Manuscript in preparation

License

This package is released under the MIT License. See LICENSE file for details.

Copy Link

Version

Install

install.packages('kdps')

Monthly Downloads

197

Version

1.0.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Wanjun Gu

Last Published

July 22nd, 2025

Functions in kdps (1.0.0)

kdps

Kinship Decouple and Phenotype Selection (KDPS)