Skip to main content

No project description provided

Project description

GADO Runner for PhEval

This is the GADO plugin for PhEval. With this plugin, you can leverage the gene prioritisation tool, GADO, 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.gado repo and set up the poetry environment:

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

cd pheval.gado

poetry shell

poetry install

or install with PyPi:

pip install pheval.gado

Configuring a single run

Setting up the input directory

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

tool: GADO
tool_version: 1.0.1
variant_analysis: False
gene_analysis: True
disease_analysis: False
tool_specific_configuration_options:
  gado_jar: GadoCommandline-1.0.1/GADO.jar
  hpo_ontology: hp.obo
  hpo_predictions_info: predictions_auc_bonf.txt
  genes: hpo_prediction_genes.txt
  hpo_predictions: genenetwork_bonf_spiked/genenetwork_bonf_spiked.dat

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

All GADO input data files required for running (specified in the tool_specific_configuration_options) should be located in the input directory. The gado_jar points to the name of the GADO jar file which should also be located in the input directory.

The overall structure of the input directory should look something like so:

.
├── GadoCommandline-1.0.1
├── config.yaml
├── predictions_auc_bonf.txt
├── hp.obo
├── hpo_prediction_genes.txt
└── genenetwork_bonf_spiked
   └── genenetwork_bonf_spiked.dat

Setting up the testdata directory

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

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 gadophevalrunner \
--output-dir /path/to/output_dir \
--version 1.0.1

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_gado-0.1.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

pheval_gado-0.1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file pheval_gado-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for pheval_gado-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b950440ee329e6f90492664a9f8e994fd95d9eca9c6dade015e179fa8be85a97
MD5 351d27a2ef7c3c069bf0f29e87d77e25
BLAKE2b-256 fa25a626603e4294c02c0e5a5b84e2ad2b5b01c09317636c95e06a4771608f7d

See more details on using hashes here.

Provenance

File details

Details for the file pheval_gado-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pheval_gado-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for pheval_gado-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa380359561ad06d01f02bda842847f9175c48f1ebda7199a8ebf535dc8905e5
MD5 37fa500c3f074518d58c42bb1cf43a1a
BLAKE2b-256 c27f27433b5f77b52aa8829df946aaf195bc0770f24d8419398c4fccd6bc4eb9

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