pheval-exomiser 0.2.3__tar.gz → 0.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/PKG-INFO +13 -4
  2. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/README.md +11 -3
  3. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/pyproject.toml +2 -2
  4. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/__init__.py +0 -0
  5. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/cli.py +0 -0
  6. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/constants.py +0 -0
  7. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/post_process/__init__.py +0 -0
  8. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/post_process/post_process.py +0 -0
  9. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/post_process/post_process_results_format.py +0 -0
  10. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/prepare/__init__.py +0 -0
  11. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/prepare/create_batch_commands.py +0 -0
  12. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/prepare/tool_specific_configuration_options.py +0 -0
  13. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/prepare/write_application_properties.py +0 -0
  14. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/prepare/yaml_to_family_phenopacket.py +0 -0
  15. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/run/__init__.py +0 -0
  16. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/run/run.py +0 -0
  17. {pheval_exomiser-0.2.3 → pheval_exomiser-0.2.4}/src/pheval_exomiser/runner.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pheval_exomiser
3
- Version: 0.2.3
3
+ Version: 0.2.4
4
4
  Summary:
5
5
  Author: Yasemin Bridges
6
6
  Author-email: y.bridges@qmul.ac.uk
@@ -16,7 +16,7 @@ Requires-Dist: google (>=3.0.0,<4.0.0)
16
16
  Requires-Dist: oaklib (>=0.5.12,<0.6.0)
17
17
  Requires-Dist: pandas (>=1.5.2,<2.0.0)
18
18
  Requires-Dist: phenopackets (>=2.0.2,<3.0.0)
19
- Requires-Dist: pheval (>=0.3.1,<0.4.0)
19
+ Requires-Dist: pheval (>=0.4.0,<0.5.0)
20
20
  Requires-Dist: pyaml (>=21.10.1,<22.0.0)
21
21
  Requires-Dist: pydantic (>=1.10.7,<2.0.0)
22
22
  Description-Content-Type: text/markdown
@@ -27,7 +27,13 @@ This is the Exomiser plugin for PhEval. With this plugin, you can leverage the v
27
27
 
28
28
  ## Installation
29
29
 
30
- Clone the pheval.exomiser repo and set up the poetry environment:
30
+ You can install the Exomiser directly with PyPi (recommended):
31
+
32
+ ```shell
33
+ pip install pheval.exomiser
34
+ ```
35
+
36
+ Alternatively you can clone the pheval.exomiser repo and set up the poetry environment:
31
37
 
32
38
  ```shell
33
39
  git clone https://github.com/monarch-initiative/pheval.exomiser.git
@@ -80,6 +86,8 @@ The analysis configuration file (in this case: `preset-exome-analysis.yml`) shou
80
86
 
81
87
  The whitelist paths for the hg19 and hg38 dbs need only be specified for Exomiser v13.3.0 and earlier (unless specifying your own whitelist), as Exomiser v14.0.0 now includes this in the db.
82
88
 
89
+ To save on diskspace we recommend limiting the Exomiser output to JSON, this can be specified by setting the `output_formats` field in the `config.yaml` to [JSON]
90
+
83
91
  If using optional databases, such as REMM/CADD/local frequency the optional data input should look like so in the input
84
92
  directory:
85
93
 
@@ -142,7 +150,7 @@ The overall structure of the input directory should look like this with the cadd
142
150
  ```
143
151
  ### Setting up the testdata directory
144
152
 
145
- The Exomiser plugin for PhEval accepts phenopackets and vcf files as an input for running Exomiser. The plugin can be run in `phenotype_only` mode, where only phenopackets are required as an input, however, this *must* be specified in the `config.yaml`.
153
+ The Exomiser plugin for PhEval accepts phenopackets and vcf files as an input for running Exomiser. The plugin can be run in `phenotype_only` mode, where only phenopackets are required as an input, however, this *must* be specified in the `config.yaml` by setting `variant_analysis: False`
146
154
 
147
155
  The testdata directory should include subdirectories named `phenopackets` and `vcf` if running with variant prioritisation.
148
156
 
@@ -182,3 +190,4 @@ To fix the error, `setuptools` needs to be downgraded to version 66:
182
190
  pip uninstall setuptools
183
191
  pip install -U setuptools=="66"
184
192
  ```
193
+
@@ -4,7 +4,13 @@ This is the Exomiser plugin for PhEval. With this plugin, you can leverage the v
4
4
 
5
5
  ## Installation
6
6
 
7
- Clone the pheval.exomiser repo and set up the poetry environment:
7
+ You can install the Exomiser directly with PyPi (recommended):
8
+
9
+ ```shell
10
+ pip install pheval.exomiser
11
+ ```
12
+
13
+ Alternatively you can clone the pheval.exomiser repo and set up the poetry environment:
8
14
 
9
15
  ```shell
10
16
  git clone https://github.com/monarch-initiative/pheval.exomiser.git
@@ -57,6 +63,8 @@ The analysis configuration file (in this case: `preset-exome-analysis.yml`) shou
57
63
 
58
64
  The whitelist paths for the hg19 and hg38 dbs need only be specified for Exomiser v13.3.0 and earlier (unless specifying your own whitelist), as Exomiser v14.0.0 now includes this in the db.
59
65
 
66
+ To save on diskspace we recommend limiting the Exomiser output to JSON, this can be specified by setting the `output_formats` field in the `config.yaml` to [JSON]
67
+
60
68
  If using optional databases, such as REMM/CADD/local frequency the optional data input should look like so in the input
61
69
  directory:
62
70
 
@@ -119,7 +127,7 @@ The overall structure of the input directory should look like this with the cadd
119
127
  ```
120
128
  ### Setting up the testdata directory
121
129
 
122
- The Exomiser plugin for PhEval accepts phenopackets and vcf files as an input for running Exomiser. The plugin can be run in `phenotype_only` mode, where only phenopackets are required as an input, however, this *must* be specified in the `config.yaml`.
130
+ The Exomiser plugin for PhEval accepts phenopackets and vcf files as an input for running Exomiser. The plugin can be run in `phenotype_only` mode, where only phenopackets are required as an input, however, this *must* be specified in the `config.yaml` by setting `variant_analysis: False`
123
131
 
124
132
  The testdata directory should include subdirectories named `phenopackets` and `vcf` if running with variant prioritisation.
125
133
 
@@ -158,4 +166,4 @@ To fix the error, `setuptools` needs to be downgraded to version 66:
158
166
  ```shell
159
167
  pip uninstall setuptools
160
168
  pip install -U setuptools=="66"
161
- ```
169
+ ```
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "pheval_exomiser"
3
- version = "0.2.3"
3
+ version = "0.2.4"
4
4
  description = ""
5
5
  authors = ["Yasemin Bridges <y.bridges@qmul.ac.uk>",
6
6
  "Julius Jacobsen <j.jacobsen@qmul.ac.uk>",
@@ -19,7 +19,7 @@ pyaml = "^21.10.1"
19
19
  oaklib = "^0.5.12"
20
20
  docker = "^6.0.1"
21
21
  pydantic = "^1.10.7"
22
- pheval = "^0.3.1"
22
+ pheval = "^0.4.0"
23
23
 
24
24
  [tool.poetry.dev-dependencies]
25
25
  pytest = "^7.1.2"