Skip to main content

This is the package for various epistasis related softwares.

Project description

DOI

icon

Fast Model-X Kernel-based Set Testing Toolkits

https://pypi.org/project/fast-kernel-set-test/0.1.0/

This folder has been updated with both the FastKAST and QuadKAST

Please check sub-branch for detailed instruction on each specific method.

Table of contents:

  1. Installation
  2. Basic usage
    1. FastKAST
    2. QuadKAST
  3. Useful functions

Installation

  1. You need python >= 3.60 in order to run the code (anaconda3 recommended)
  2. pip install fast-kernel-set-test or install from source

You can either follow the standard pipeline FastKAST_annot.py and QuadKAST_annot.py, or import the neccessary function to build based on your own I/O.

Basic usage

FastKAST

To run the demo FastKAST code with a customized window size, you can generate a annotation file with "start_index end_index" as a row, and run

python FastKAST_annot.py --bfile ./example/sim --phen ./example/sim.pheno --annot ./example/sim.new.annot

Or directly run

sh run_rbf_annot.sh

QuadKAST

To run the demo QuadKAST code with a customized window size, you can generate a annotation file with "start_index end_index" as a row, and run

python QuadKAST_annot.py --bfile ./example/sim --phen ./example/sim.pheno --annot ./example/sim.new.annot

Or directly run

sh run_quad_annot.sh

Useful functions

  • Single trait analysis
## Given covariates c: (NxM), input Z: (NxD), and output y: (Nx1)
from FastKAST import getfullComponentPerm
results = getfullComponentPerm(c,Z,y,Perm=10)
## results: {'pval': [obs_pval, perm_pval1, ..., perm_pval10]}     
  • Multi-traits analysis
## Given covariates c: (NxM), input Z: (NxD), and output y: (NxK)
from FastKAST import getfullComponentMulti
results = getfullComponentMulti(c,Z,y)
## results: {'pval': [obs_pval1, obs_pval2, ..., obs_pvalK]}     

Data availability

The detailed statistics used to generate the main table and the Venn diagram of the paper are provided in the Data folder

✅ Efficient multi-traits analysis (Sep 30, 2024)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fast-kernel-set-test-0.1.1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fast_kernel_set_test-0.1.1-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

Details for the file fast-kernel-set-test-0.1.1.tar.gz.

File metadata

  • Download URL: fast-kernel-set-test-0.1.1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.5

File hashes

Hashes for fast-kernel-set-test-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3f5ee4fcf7eebc68c76cc71ea48be827cace1f8366af3f1bfe7c7b4c0846b37b
MD5 17dea31edfd5a3fbf3f41e8cd2cb42df
BLAKE2b-256 1d94c40b2840f2dcb45225a0866ded985cc148db6f9408cee63ac144acc40584

See more details on using hashes here.

File details

Details for the file fast_kernel_set_test-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fast_kernel_set_test-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 51bac5a61f7bc9f18e4e40a1c5d764dd4937c683a9297f9492cde441b356b014
MD5 97b433b9db80b414add39b9254bab5ac
BLAKE2b-256 8e42ef8d99fed76dc9225f346a5903a8ce221ae8e05ef9ad95fd190af8b57636

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page