跳转到主要内容

未提供项目描述

项目描述

PhEval的Exomiser运行器

这是PhEval的Exomiser插件。使用此插件,您可以使用Exomiser变体优先级工具,无缝运行PhEval管道。有关如何使用Exomiser运行器设置和运行PhEval Makefile管道的详细文档,请参阅此处。运行完整PhEval Makefile管道的设置过程与单次运行的设置过程不同。Makefile管道为语料库和配置创建目录结构以处理多个运行配置。有关设置适当的目录布局的详细说明,包括输入目录和测试数据目录,请参阅此处。

安装

您可以直接使用PyPi安装Exomiser(推荐)

pip install pheval.exomiser

或者您可以克隆pheval.exomiser存储库并设置poetry环境

git clone https://github.com/monarch-initiative/pheval.exomiser.git
cd pheval.exomiser
poetry shell
poetry install

配置单个运行

设置输入目录

应将一个config.yaml文件放在输入目录中,并按如下格式进行格式化

tool: exomiser
tool_version: 13.2.0
variant_analysis: True
gene_analysis: True
disease_analysis: False
tool_specific_configuration_options:
  environment: local
  exomiser_software_directory: exomiser-cli-13.2.0
  analysis_configuration_file: preset-exome-analysis.yml
  max_jobs: 0
  application_properties:
    remm_version:
    cadd_version:
    hg19_data_version: 2302
    hg19_local_frequency_path: # name of hg19 local frequency file 
    hg19_whitelist_path: 2302_hg19_clinvar_whitelist.tsv.gz # only required for Exomiser v13.3.0 and earlier, can be left blank for Exomiser v14.0.0 onwards.
    hg38_data_version: 2302
    hg38_local_frequency_path: # name of hg38 local frequency file 
    hg38_whitelist_path:
    phenotype_data_version: 2302
    cache_type:
    cache_caffeine_spec:
  output_formats: [JSON,HTML] # options include HTML, JSON, TSV_VARIANT, TSV_GENE, VCF
  post_process:
    score_name: combinedScore
    sort_order: DESCENDING

为了给出需求的一个概念,必须填写基本字段。这样可以为Exomiser的application.properties文件正确配置。提供了一个示例配置pheval.exomiser/config.yaml

Exomiser输入数据目录(表型数据库和变异数据库)也应位于输入目录中 - 或者一个指向该位置的符号链接。

exomiser_software_directory指向输入目录中Exomiser发行版目录的名称。

分析配置文件(在本例中:preset-exome-analysis.yml)应位于输入目录中。

对于hg19和hg38数据库的白名单路径,只需为Exomiser v13.3.0及以前版本指定(除非指定自己的白名单),因为Exomiser v14.0.0现在已将其包含在数据库中。

为了节省磁盘空间,我们建议将Exomiser输出限制为JSON,这可以通过将config.yaml中的output_formats字段设置为[JSON]来指定。

如果使用可选数据库,如REMM/CADD/本地频率,可选数据输入应如下所示在输入目录中

├── cadd
│   └── {{CADD-VERSION}}
│       ├── hg19
│       │   ├── InDels.tsv.gz
│       │   └── whole_genome_SNVs.tsv.gz
│       └── hg38
│           ├── InDels.tsv.gz
│           └── whole_genome_SNVs.tsv.gz
├── local
│   ├── local_frequency_test_hg19.tsv.gz
│   └── local_frequency_test_hg38.tsv.gz
└── remm
    ├── ReMM.v{{REMM-VERSION}}.hg19.tsv.gz
    └── ReMM.v{{REMM-VERSION}}.hg38.tsv.gz

输入目录的整体结构应如下所示,其中cadd、local和remm目录是可选的,具体取决于Exomiser配置

.
├── 2302_hg19
│   ├── 2302_hg19_clinvar_whitelist.tsv.gz
│   ├── 2302_hg19_clinvar_whitelist.tsv.gz.tbi
│   ├── 2302_hg19_genome.h2.db
│   ├── 2302_hg19_transcripts_ensembl.ser
│   ├── 2302_hg19_transcripts_refseq.ser
│   ├── 2302_hg19_transcripts_ucsc.ser
│   └── 2302_hg19_variants.mv.db
├── 2302_phenotype
│   ├── 2302_phenotype.h2.db
│   ├── hp.obo
│   ├── phenix
│   │   ├── ALL_SOURCES_ALL_FREQUENCIES_genes_to_phenotype.txt
│   │   ├── hp.obo
│   │   └── out
│   └── rw_string_10.mv
├── config.yaml
├── exomiser-cli-13.2.0
│   ├── lib
│   └── exomiser-cli-13.2.0.jar
├── preset-exome-analysis.yml
├── cadd
│   └── {{CADD-VERSION}}
│       ├── hg19
│       │   ├── InDels.tsv.gz
│       │   └── whole_genome_SNVs.tsv.gz
│       └── hg38
│           ├── InDels.tsv.gz
│           └── whole_genome_SNVs.tsv.gz
├── local
│   ├── local_frequency_test_hg19.tsv.gz
│   └── local_frequency_test_hg38.tsv.gz
└── remm
    ├── ReMM.v{{REMM-VERSION}}.hg19.tsv.gz
    └── ReMM.v{{REMM-VERSION}}.hg38.tsv.gz

设置testdata目录

PhEval的Exomiser插件接受phenopackets和vcf文件作为运行Exomiser的输入。插件可以在phenotype_only模式下运行,其中只需要phenopackets作为输入,但是必须在config.yaml中通过设置variant_analysis: False来指定。

如果运行带有变异优先级的测试数据,则testdata目录应包括名为phenopacketsvcf的子目录。

例如:

├── testdata_dir
   ├── phenopackets
   └── vcf

运行命令

一旦正确配置了运行测试数据和输入目录,就可以执行pheval run命令。

pheval run --input-dir /path/to/input_dir \
--testdata-dir /path/to/testdata_dir \
--runner exomiserphevalrunner \
--output-dir /path/to/output_dir \
--version 13.2.0

常见错误

您可能会看到一个与当前使用的setuptools相关的错误

pkg_resources.extern.packaging.requirements.InvalidRequirement: Expected closing RIGHT_PARENTHESIS
    requests (<3,>=2.12.*) ; extra == 'parse'
             ~~~~~~~~~~^

为了修复错误,需要将setuptools降级到版本66

pip uninstall setuptools
pip install -U setuptools=="66"

项目详情


下载文件

下载适用于您平台的应用程序。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

pheval_exomiser-0.2.4.tar.gz (17.9 kB 查看哈希值)

上传时间

构建分布

pheval_exomiser-0.2.4-py3-none-any.whl (20.0 kB 查看哈希值)

上传时间 Python 3

由以下支持