pitools:一个python程序,用于阶段化和插补数据。
pitools的Python项目详细描述
简介
pitools是ngs数据的分阶段和插补工具,它是 插补服务器核心:https://imputation.cngb.org/。你可以用皮托 作为本地Linux集群中自己的插补管道。
快速启动
pitools使用eagle进行相位调整 以及Minimac3的责任。
安装
通过pip安装发布的版本:
pip install pitools
或者您可能希望从github安装开发版本, 通过运行:
pip install git+git://github.com/ShujiaHuang/pitools.git#egg=pitools
此命令将在系统中安装pitools,您可以在 你的命令。
使用量
您可以通过运行 pitools impute --help:
usage: pitools impute [-h] -C CONFIG [-M IMPUTE_METHOD] [-P PHASE_METHOD] -I IN_VCF -O OUT_PREFIX --refpanel-version REFPANEL --reference-build REFBUILD [--unprephase] [--regions chr:start-end] [--nCPU NCPU] optional arguments: -h, --help show this help message and exit -C CONFIG, --conf CONFIG YAML configuration file specifying details information for imputation -M IMPUTE_METHOD, --methods IMPUTE_METHOD Tool for imputation. [minimac] -P PHASE_METHOD, --prephase-method PHASE_METHOD Tool for pre-phase before imputation. [eagle] -I IN_VCF, --input IN_VCF Input one VCF file to analyze. Required -O OUT_PREFIX, --outprefix OUT_PREFIX Prefix for output files. Required --refpanel-version REFPANEL The version of haplotype data for reference panel. Required --reference-build REFBUILD The build version of reference, e.g: GRCh37 --unprephase Do not perform pre-phased before the imputation process. --regions chr:start-end Skip positions which not in these regions. This parameter could be a list of comma deleimited genome regions(e.g.: chr:start-end,chr:start-end) --nCPU NCPU Number of threads. [1]
配置文件
pitools需要一个用于设置阶段化路径的配置文件 程序,插补程序,参考版本和参考小组。 下面是如何创建配置文件的示例之一: config.yaml。
现在您可以使用pitools作为强大的插补管道,一旦您 已经完成设置。
示例
这个命令足够你做大部分工作了。
pitools impute -C config.yaml \ -I your.vcf.gz \ -O test_outprefix \ --refpanel-version 1000G_P3_GRCh37 \ --reference-build GRCh37 \ --nCPU 4
如果你只想在某个特定的 区域。下面是在基因组区域运行pitools的示例: 21:38347375-38500731和22:17203103-17439826。
pitools impute -C config.yaml \ -I your.vcf.gz \ -O test_outprefix \ --refpanel-version 1000G_P3_GRCh37 \ --reference-build GRCh37 \ --regions 21:38347375-38500731,22:17203103-17439826 \ --nCPU 4
PI将在执行插补之前自动执行预相位 过程。但有时你的输入VCF文件已经分阶段了。以及 您不想再运行它,然后可以设置--unprephase 参数跳过该过程。
pitools impute -C config.yaml \ -I your.vcf.gz \ -O test_outprefix \ --refpanel-version 1000G_P3_GRCh37 \ --reference-build GRCh37 \ --unprephase \ --nCPU 4