eukcc 2.2.0__tar.gz → 2.3.1__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 (37) hide show
  1. {eukcc-2.2.0/eukcc.egg-info → eukcc-2.3.1}/PKG-INFO +44 -32
  2. {eukcc-2.2.0 → eukcc-2.3.1}/README.md +35 -26
  3. eukcc-2.3.1/eukcc/__init__.py +3 -0
  4. eukcc-2.3.1/eukcc/__main__.py +465 -0
  5. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/base.py +17 -2
  6. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/bin.py +11 -3
  7. eukcc-2.3.1/eukcc/constants.py +10 -0
  8. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/eukcc.py +116 -123
  9. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/exec.py +16 -18
  10. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/fasta.py +56 -35
  11. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/file.py +1 -1
  12. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/find_markerset.py +6 -6
  13. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/helper.py +2 -2
  14. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/refine.py +74 -56
  15. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/set_define.py +15 -8
  16. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc/treehandler.py +65 -47
  17. {eukcc-2.2.0 → eukcc-2.3.1/eukcc.egg-info}/PKG-INFO +44 -32
  18. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc.egg-info/SOURCES.txt +2 -8
  19. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc.egg-info/entry_points.txt +2 -0
  20. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc.egg-info/requires.txt +2 -0
  21. {eukcc-2.2.0 → eukcc-2.3.1}/pyproject.toml +9 -6
  22. {eukcc-2.2.0 → eukcc-2.3.1}/scripts/binlinks.py +35 -30
  23. {eukcc-2.2.0 → eukcc-2.3.1}/scripts/filter_euk_bins.py +33 -63
  24. eukcc-2.2.0/eukcc/__init__.py +0 -0
  25. eukcc-2.2.0/eukcc/__main__.py +0 -512
  26. eukcc-2.2.0/eukcc/version.py +0 -1
  27. eukcc-2.2.0/setup.py +0 -37
  28. eukcc-2.2.0/tests/test_basic.py +0 -92
  29. eukcc-2.2.0/tests/test_eukcc.py +0 -7
  30. eukcc-2.2.0/tests/test_fasta.py +0 -73
  31. eukcc-2.2.0/tests/test_file.py +0 -14
  32. eukcc-2.2.0/tests/test_tree.py +0 -42
  33. {eukcc-2.2.0 → eukcc-2.3.1}/LICENSE +0 -0
  34. {eukcc-2.2.0 → eukcc-2.3.1}/MANIFEST.in +0 -0
  35. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc.egg-info/dependency_links.txt +0 -0
  36. {eukcc-2.2.0 → eukcc-2.3.1}/eukcc.egg-info/top_level.txt +0 -0
  37. {eukcc-2.2.0 → eukcc-2.3.1}/setup.cfg +0 -0
@@ -1,19 +1,20 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: eukcc
3
- Version: 2.2.0
3
+ Version: 2.3.1
4
4
  Summary: Check eukaryotic genomes or MAGs for completeness and contamination
5
- Home-page: https://github.com/EBI-Metagenomics/EukCC
6
- Author: Paul Saary
7
5
  Author-email: Paul Saary <eukcc@paulsaary.de>, MGnify team <metagenomics-help@ebi.ac.uk>
8
6
  License: GPLv3
9
7
  Project-URL: Homepage, https://github.com/EBI-Metagenomics/EukCC
10
8
  Project-URL: Documentation, https://eukcc.readthedocs.io/
11
9
  Keywords: bioinformatics,mags,eukaryotic,completeness,contamination
12
- Classifier: Programming Language :: Python :: 3.6
10
+ Classifier: Programming Language :: Python :: 3.10
11
+ Classifier: Programming Language :: Python :: 3.11
13
12
  Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
14
13
  Classifier: Operating System :: Unix
15
- Requires-Python: >=3.6
14
+ Requires-Python: <3.12,>=3.10
16
15
  Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+ Requires-Dist: click>=8.1
17
18
  Requires-Dist: ete3>=3.1.3
18
19
  Requires-Dist: numpy>=1.24.4
19
20
  Requires-Dist: jsonpickle>=4.0.0
@@ -24,6 +25,7 @@ Provides-Extra: tests
24
25
  Requires-Dist: pytest==7.4.0; extra == "tests"
25
26
  Requires-Dist: pytest-md==0.2.0; extra == "tests"
26
27
  Requires-Dist: pytest-workflow==2.0.1; extra == "tests"
28
+ Requires-Dist: click>=8.1; extra == "tests"
27
29
  Requires-Dist: ete3>=3.1.3; extra == "tests"
28
30
  Requires-Dist: numpy>=1.24.4; extra == "tests"
29
31
  Requires-Dist: jsonpickle>=4.0.0; extra == "tests"
@@ -35,6 +37,7 @@ Requires-Dist: pre-commit==3.8.0; extra == "dev"
35
37
  Requires-Dist: black==24.8.0; extra == "dev"
36
38
  Requires-Dist: flake8==7.1.1; extra == "dev"
37
39
  Requires-Dist: pep8-naming==0.14.1; extra == "dev"
40
+ Dynamic: license-file
38
41
 
39
42
  # EukCC
40
43
 
@@ -49,31 +52,41 @@ Head over to https://eukcc.readthedocs.io/ to check out the documentation.
49
52
  ## Run
50
53
 
51
54
  ### Download EukCC2 database from [FTP](http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/)
55
+
56
+ With EukCC installed, `eukcc download_db` downloads and extracts the current database
57
+ (use `--url` for another version from the FTP):
58
+ ```
59
+ eukcc download_db --out eukccdb
60
+ export EUKCC2_DB=$(realpath eukccdb/eukcc2_db_ver_2026-11)
61
+ ```
62
+
63
+ Or by hand:
52
64
  ```
53
65
  # create a folder were to keep the database
54
66
  mkdir eukccdb
55
67
  cd eukccdb
56
- wget http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/eukcc2_db_ver_1.2.tar.gz
57
- tar -xzvf eukcc2_db_ver_1.2.tar.gz
58
- export EUKCC2_DB=$(realpath eukcc2_db_ver_1.2)
68
+ wget http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/eukcc2_db_ver_2026-11.tar.gz
69
+ tar -xzvf eukcc2_db_ver_2026-11.tar.gz
70
+ export EUKCC2_DB=$(realpath eukcc2_db_ver_2026-11)
59
71
  ```
60
72
 
61
73
  ### Quickstart using container
62
74
 
63
- Get EukCC quickly by fetching the container.
75
+ Get EukCC quickly by fetching the BioContainers image:
76
+ https://quay.io/repository/biocontainers/eukcc
77
+
78
+ These images have no `latest` tag, so pick a version tag from the repository:
64
79
 
65
- The container is hosted and automatically build from the master branch here:
66
- https://quay.io/repository/microbiome-informatics/eukcc
67
80
  ```
68
- docker pull quay.io/microbiome-informatics/eukcc
69
- singularity pull docker://quay.io/microbiome-informatics/eukcc
81
+ docker pull quay.io/biocontainers/eukcc:<tag>
82
+ singularity pull docker://quay.io/biocontainers/eukcc:<tag>
70
83
  ```
71
84
 
72
85
  ### Bioconda / pip
73
86
 
74
- Alternatively you can install EukCC using conda or pip.
87
+ Alternatively you can install EukCC using conda or pip.
75
88
 
76
- In addition, you need to install mandatory requirements:
89
+ With pip, you also need to install these mandatory requirements:
77
90
  - metaeuk=4.a0f584d
78
91
  - pplacer
79
92
  - epa-ng=0.3.8
@@ -89,14 +102,14 @@ In addition, you need to install mandatory requirements:
89
102
 
90
103
  ### eukcc single
91
104
 
92
- - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage
105
+ - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names)
93
106
 
94
107
  ### eukcc folder
95
108
 
96
- - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage for **good** quality bins
97
- - `merged_bins.csv` - table of merged refined bins
98
- - `bad_quality.csv`- table with estimated completeness, contamination and taxonomy lineage for **bad** quality bins (chosen marker gene set is supported by less than half of the alignments)
99
- - `missing_marker_genes.txt` - line separated list of bins with not defined set of marker genes
109
+ - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names) for **good** quality bins. Bins that could not be estimated (zero predicted proteins or no marker gene set) are listed with `NA`
110
+ - `merged_bins.tsv` - table of merged refined bins
111
+ - `bad_quality.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names) for **bad** quality bins (chosen marker gene set is supported by less than half of the alignments)
112
+ - `missing_marker_genes.txt` - line separated list of bins that could not be estimated (zero predicted proteins or no marker gene set)
100
113
  - `merged_bins` - folder with merged bins sequences
101
114
  - `refine_workdir` - working directory with intermediate steps results
102
115
 
@@ -104,8 +117,9 @@ In addition, you need to install mandatory requirements:
104
117
  ## Don't use EukCC on already pubished data
105
118
  Or at least not without thinking about it:
106
119
 
107
- You should not use EukCC on already published genomes, if they have used during training of the marker
108
- gene sets. If you want to make sure, you can see all used accessions in the database file `db_base/backbone/base_taxinfo.csv`.
120
+ You should not use EukCC on already published genomes, if they were used during training of the marker
121
+ gene sets. If you want to make sure, the accessions used are listed in the `taxinfo` file of each
122
+ sub-database of the EukCC database (`files.taxinfo` in `db_<clade>/db_info.json`).
109
123
 
110
124
  ## Cite
111
125
 
@@ -120,6 +134,10 @@ Genome biology 21.1 (2020): 1-21.
120
134
  EukCC also uses metaEUK, hmmer, pplacer, ete3 and epa-ng.
121
135
 
122
136
 
137
+ ## Changelog
138
+
139
+ See [CHANGELOG.md](CHANGELOG.md) for the changes in each version.
140
+
123
141
  ## Changed compared to EukCC 1
124
142
  **Note**:
125
143
  With version 2, EukCC should provide a better experience than
@@ -133,14 +151,8 @@ So version 2 is **not** a drop in replacement.
133
151
  ## Issues and bugs
134
152
 
135
153
  Please report any bugs and issues here on GitHub. Make sure to
136
- include the debug log (run eukcc using `--debug` flag).
154
+ include the debug log (run eukcc using the `--debug` flag, e.g. `eukcc single --debug ...`).
137
155
 
138
156
  ### used exit codes
139
- - 200: File not found
140
- - 201: No Marker gene set could be defined
141
- - 202: No database provided
142
- - 203: Corrupted file
143
- - 204: Predicted zero proteins
144
- - 222: Invalid settings
145
-
146
-
157
+ - 0: Success.
158
+ - 1: Error, the reason is reported in the log
@@ -11,31 +11,41 @@ Head over to https://eukcc.readthedocs.io/ to check out the documentation.
11
11
  ## Run
12
12
 
13
13
  ### Download EukCC2 database from [FTP](http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/)
14
+
15
+ With EukCC installed, `eukcc download_db` downloads and extracts the current database
16
+ (use `--url` for another version from the FTP):
17
+ ```
18
+ eukcc download_db --out eukccdb
19
+ export EUKCC2_DB=$(realpath eukccdb/eukcc2_db_ver_2026-11)
20
+ ```
21
+
22
+ Or by hand:
14
23
  ```
15
24
  # create a folder were to keep the database
16
25
  mkdir eukccdb
17
26
  cd eukccdb
18
- wget http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/eukcc2_db_ver_1.2.tar.gz
19
- tar -xzvf eukcc2_db_ver_1.2.tar.gz
20
- export EUKCC2_DB=$(realpath eukcc2_db_ver_1.2)
27
+ wget http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/eukcc2_db_ver_2026-11.tar.gz
28
+ tar -xzvf eukcc2_db_ver_2026-11.tar.gz
29
+ export EUKCC2_DB=$(realpath eukcc2_db_ver_2026-11)
21
30
  ```
22
31
 
23
32
  ### Quickstart using container
24
33
 
25
- Get EukCC quickly by fetching the container.
34
+ Get EukCC quickly by fetching the BioContainers image:
35
+ https://quay.io/repository/biocontainers/eukcc
36
+
37
+ These images have no `latest` tag, so pick a version tag from the repository:
26
38
 
27
- The container is hosted and automatically build from the master branch here:
28
- https://quay.io/repository/microbiome-informatics/eukcc
29
39
  ```
30
- docker pull quay.io/microbiome-informatics/eukcc
31
- singularity pull docker://quay.io/microbiome-informatics/eukcc
40
+ docker pull quay.io/biocontainers/eukcc:<tag>
41
+ singularity pull docker://quay.io/biocontainers/eukcc:<tag>
32
42
  ```
33
43
 
34
44
  ### Bioconda / pip
35
45
 
36
- Alternatively you can install EukCC using conda or pip.
46
+ Alternatively you can install EukCC using conda or pip.
37
47
 
38
- In addition, you need to install mandatory requirements:
48
+ With pip, you also need to install these mandatory requirements:
39
49
  - metaeuk=4.a0f584d
40
50
  - pplacer
41
51
  - epa-ng=0.3.8
@@ -51,14 +61,14 @@ In addition, you need to install mandatory requirements:
51
61
 
52
62
  ### eukcc single
53
63
 
54
- - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage
64
+ - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names)
55
65
 
56
66
  ### eukcc folder
57
67
 
58
- - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage for **good** quality bins
59
- - `merged_bins.csv` - table of merged refined bins
60
- - `bad_quality.csv`- table with estimated completeness, contamination and taxonomy lineage for **bad** quality bins (chosen marker gene set is supported by less than half of the alignments)
61
- - `missing_marker_genes.txt` - line separated list of bins with not defined set of marker genes
68
+ - `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names) for **good** quality bins. Bins that could not be estimated (zero predicted proteins or no marker gene set) are listed with `NA`
69
+ - `merged_bins.tsv` - table of merged refined bins
70
+ - `bad_quality.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names) for **bad** quality bins (chosen marker gene set is supported by less than half of the alignments)
71
+ - `missing_marker_genes.txt` - line separated list of bins that could not be estimated (zero predicted proteins or no marker gene set)
62
72
  - `merged_bins` - folder with merged bins sequences
63
73
  - `refine_workdir` - working directory with intermediate steps results
64
74
 
@@ -66,8 +76,9 @@ In addition, you need to install mandatory requirements:
66
76
  ## Don't use EukCC on already pubished data
67
77
  Or at least not without thinking about it:
68
78
 
69
- You should not use EukCC on already published genomes, if they have used during training of the marker
70
- gene sets. If you want to make sure, you can see all used accessions in the database file `db_base/backbone/base_taxinfo.csv`.
79
+ You should not use EukCC on already published genomes, if they were used during training of the marker
80
+ gene sets. If you want to make sure, the accessions used are listed in the `taxinfo` file of each
81
+ sub-database of the EukCC database (`files.taxinfo` in `db_<clade>/db_info.json`).
71
82
 
72
83
  ## Cite
73
84
 
@@ -82,6 +93,10 @@ Genome biology 21.1 (2020): 1-21.
82
93
  EukCC also uses metaEUK, hmmer, pplacer, ete3 and epa-ng.
83
94
 
84
95
 
96
+ ## Changelog
97
+
98
+ See [CHANGELOG.md](CHANGELOG.md) for the changes in each version.
99
+
85
100
  ## Changed compared to EukCC 1
86
101
  **Note**:
87
102
  With version 2, EukCC should provide a better experience than
@@ -95,14 +110,8 @@ So version 2 is **not** a drop in replacement.
95
110
  ## Issues and bugs
96
111
 
97
112
  Please report any bugs and issues here on GitHub. Make sure to
98
- include the debug log (run eukcc using `--debug` flag).
113
+ include the debug log (run eukcc using the `--debug` flag, e.g. `eukcc single --debug ...`).
99
114
 
100
115
  ### used exit codes
101
- - 200: File not found
102
- - 201: No Marker gene set could be defined
103
- - 202: No database provided
104
- - 203: Corrupted file
105
- - 204: Predicted zero proteins
106
- - 222: Invalid settings
107
-
108
-
116
+ - 0: Success.
117
+ - 1: Error, the reason is reported in the log
@@ -0,0 +1,3 @@
1
+ from importlib.metadata import version
2
+
3
+ __version__ = version("eukcc")