Skip to main content

No project description provided

Project description

Phen2Gene Runner for PhEval

This is the Phen2Gene plugin for PhEval. With this plugin, you can leverage the gene prioritisation tool, Phen2Gene, to run the PhEval pipeline seamlessly. The setup process for running the full PhEval Makefile pipeline differs from setting up for a single run. The Makefile pipeline creates directory structures for corpora and configurations to handle multiple run configurations. Detailed instructions on setting up the appropriate directory layout, including the input directory and test data directory, can be found here.

Installation

Clone the pheval.phen2gene repo and set up the poetry environment:

git clone https://github.com/monarch-initiative/pheval.phen2gene.git

cd pheval.phen2gene

poetry shell

poetry install

or install with PyPi:

pip install pheval.phen2gene

Configuring a single run

Setting up the input directory

A config.yaml should be located in the input directory and formatted like so:

tool: phen2gene
tool_version: 1.2.3
variant_analysis: False
gene_analysis: True
disease_analysis: False
tool_specific_configuration_options:
  environment: local
  phen2gene_python_executable: phen2gene.py
  post_process:
    score_order: descending

The bare minimum fields are filled to give an idea on the requirements, as Phen2Gene is gene prioritisation tool, only gene_analysis should be set to True in the config. An example config has been provided pheval.phen2gene/config.yaml.

The Phen2Gene input data directory should also be located in the input directory - or a symlink pointing to the location in a directory named lib.

The phen2gene_python_executable points to the name of the Phen2Gene python executable file which should also be located in the input directory.

The overall structure of the input directory should look something like so (omitting files in the lib for clarity):

.
├── config.yaml
├── lib
└── phen2gene.py

Setting up the testdata directory

The Phen2Gene plugin for PhEval accepts phenopackets as an input for running Phen2Gene.

The testdata directory should include a subdirectory named phenopackets:

├── testdata_dir
   └── phenopackets

Run command

Once the testdata and input directories are correctly configured for the run, the pheval run command can be executed.

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

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

pheval_phen2gene-0.1.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

pheval_phen2gene-0.1.1-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file pheval_phen2gene-0.1.1.tar.gz.

File metadata

  • Download URL: pheval_phen2gene-0.1.1.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for pheval_phen2gene-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d0856db7f3ea3ff881af58e303aab62f9064fe9592eccb13f7e7b1d0002a19c8
MD5 82d344139b35f4cc4aa29c31a17d5d43
BLAKE2b-256 fd8ec38ece7f3bb40b101f656cafd9532daec50a7d892802299edaf19795cd3c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for pheval_phen2gene-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 67175b1670c121edc08587dd4742e5027ca83127f3c7317eb9e97e74d49ccf14
MD5 e3f9a8931cf065354fd54f8436f2e3dc
BLAKE2b-256 b73c9cb2d789a6ca64bab45ab0a2253f317a3888c1a71d38f9b5f5f93360b035

See more details on using hashes here.

Provenance

Supported by

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