PhEval的模板运行器

这是一个为创建个性化的PhEval运行器而设计的模板仓库。 PhEval（表型推断评估框架）是一个可扩展的框架，用于评估变异优先级和表型匹配流程。

目前，运行器执行了位于 src/pheval_template/run/fake_predictor.py 的模拟预测器。然而，主要目标是利用这个仓库作为开发自己的运行器的起点，允许您轻松地自定义和覆盖现有方法，因为它已经包含了与PhEval集成的所有必要设置。运行器中包含了一些示例方法，以提供如何实现的思路。

安装

git clone https://github.com/yaseminbridges/pheval.template.git
cd pheval.template
poetry install
poetry shell

使用模板运行器配置运行

应位于输入目录中的 config.yaml 并按照如下格式进行格式化

tool: template
tool_version: 1.0.0
variant_analysis: False
gene_analysis: True
disease_analysis: False
tool_specific_configuration_options:

测试数据目录应包括名为 phenopackets 的子目录 - 其中应包含phenopackets。

运行命令

pheval run --input-dir /path/to/input_dir \
--runner templatephevalrunner \
--output-dir /path/to/output_dir \
--testdata-dir /path/to/testdata_dir

基准测试

您可以使用 pheval-utils benchmark 命令进行运行基准测试

pheval-utils benchmark --directory /path/to/output_directoy \
--phenopacket-dir /path/to/phenopacket_dir \
--output-prefix OUTPUT_PREFIX \
--gene-analysis \
--plot-type bar_cumulative

提供给 --directory 参数的路径应与提供给 pheval run 命令中的 --output-dir 的相同

个性化到您自己的工具

如果您要覆盖此模板以创建自己的运行器实现，有一些关键文件需要更改以适应您的运行器实现。

1. 在 src/pheval_template/runner.py 中，应更改运行器类的名称。
2. 一旦自定义了运行器类的名称，应将 pyproject.toml 中的第15行也更改以匹配类名，然后运行 poetry lock 和 poetry install

您在CLI中提供的运行器将更改为运行器类的名称。

您还应删除 src/pheval_template/run/fake_predictor.py 并实现您自己的工具的运行。后处理中的方法也可以更改以处理您自己的工具输出。