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

|
|
4
|
+
|
|
5
|
+
EukCC is a completeness and contamination estimator for metagenomic assembled
|
|
6
|
+
microbial eukaryotic genomes.
|
|
7
|
+
|
|
8
|
+
## Documentation
|
|
9
|
+
Head over to https://eukcc.readthedocs.io/ to check out the documentation.
|
|
10
|
+
|
|
11
|
+
## Run
|
|
12
|
+
|
|
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:
|
|
23
|
+
```
|
|
24
|
+
# create a folder were to keep the database
|
|
25
|
+
mkdir eukccdb
|
|
26
|
+
cd eukccdb
|
|
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)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Quickstart using container
|
|
33
|
+
|
|
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:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
docker pull quay.io/biocontainers/eukcc:<tag>
|
|
41
|
+
singularity pull docker://quay.io/biocontainers/eukcc:<tag>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Bioconda / pip
|
|
45
|
+
|
|
46
|
+
Alternatively you can install EukCC using conda or pip.
|
|
47
|
+
|
|
48
|
+
With pip, you also need to install these mandatory requirements:
|
|
49
|
+
- metaeuk=4.a0f584d
|
|
50
|
+
- pplacer
|
|
51
|
+
- epa-ng=0.3.8
|
|
52
|
+
- hmmer=3.3
|
|
53
|
+
- minimap2
|
|
54
|
+
- bwa
|
|
55
|
+
- samtools
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## Outputs explanation
|
|
59
|
+
|
|
60
|
+
- `eukcc.log` - log of execution
|
|
61
|
+
|
|
62
|
+
### eukcc single
|
|
63
|
+
|
|
64
|
+
- `eukcc.tsv` - table with estimated completeness, contamination and taxonomy lineage (taxids and names)
|
|
65
|
+
|
|
66
|
+
### eukcc folder
|
|
67
|
+
|
|
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)
|
|
72
|
+
- `merged_bins` - folder with merged bins sequences
|
|
73
|
+
- `refine_workdir` - working directory with intermediate steps results
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## Don't use EukCC on already pubished data
|
|
77
|
+
Or at least not without thinking about it:
|
|
78
|
+
|
|
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`).
|
|
82
|
+
|
|
83
|
+
## Cite
|
|
84
|
+
|
|
85
|
+
If you use EukCC make sure to cite:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
Saary, Paul, Alex L. Mitchell, and Robert D. Finn.
|
|
89
|
+
"Estimating the quality of eukaryotic genomes recovered from metagenomic analysis with EukCC."
|
|
90
|
+
Genome biology 21.1 (2020): 1-21.
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
EukCC also uses metaEUK, hmmer, pplacer, ete3 and epa-ng.
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## Changelog
|
|
97
|
+
|
|
98
|
+
See [CHANGELOG.md](CHANGELOG.md) for the changes in each version.
|
|
99
|
+
|
|
100
|
+
## Changed compared to EukCC 1
|
|
101
|
+
**Note**:
|
|
102
|
+
With version 2, EukCC should provide a better experience than
|
|
103
|
+
version 1. Version 2 is not compatible with previous versions, most commandline arguments changed.
|
|
104
|
+
So version 2 is **not** a drop in replacement.
|
|
105
|
+
|
|
106
|
+
- Users can set the prevalence threshold for marker sets. In EukCC 1
|
|
107
|
+
this was fixed to 98% single copy prevalence. Now users could change that to be more strict.
|
|
108
|
+
We find that often 100% single copy prevalence can be found.
|
|
109
|
+
|
|
110
|
+
## Issues and bugs
|
|
111
|
+
|
|
112
|
+
Please report any bugs and issues here on GitHub. Make sure to
|
|
113
|
+
include the debug log (run eukcc using the `--debug` flag, e.g. `eukcc single --debug ...`).
|
|
114
|
+
|
|
115
|
+
### used exit codes
|
|
116
|
+
- 0: Success.
|
|
117
|
+
- 1: Error, the reason is reported in the log
|