Metadata-Version: 2.4
Name: meta_eukaryome_detect
Version: 1.0.0
Summary: Pathogen, Parasite, Eukaryote and Virus detection in metagenomes..
License: MIT
License-File: LICENSE
Author: Anthony Fullam
Author-email: anthony.fullam@embl.de
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: black (>=23.10.1,<24.0.0) ; extra == "test"
Requires-Dist: bump2version (>=1.0.1,<2.0.0) ; extra == "dev"
Requires-Dist: flake8 (>=3.9.2,<4.0.0) ; extra == "test"
Requires-Dist: flake8-docstrings (>=1.6.0,<2.0.0) ; extra == "test"
Requires-Dist: isort (>=5.8.0,<6.0.0) ; extra == "test"
Requires-Dist: mkdocs (>=1.5.3,<2.0.0) ; extra == "doc"
Requires-Dist: mkdocs-autorefs (>=0.5.0,<0.6.0) ; extra == "doc"
Requires-Dist: mkdocs-include-markdown-plugin (>=6.0.3,<7.0.0) ; extra == "doc"
Requires-Dist: mkdocs-material (>=6.1.7,<7.0.0) ; extra == "doc"
Requires-Dist: mkdocs-material-extensions (>=1.0.1,<2.0.0) ; extra == "doc"
Requires-Dist: mkdocstrings (>=0.23.0,<0.24.0) ; extra == "doc"
Requires-Dist: mkdocstrings-python (>=1.7.3,<2.0.0) ; extra == "doc"
Requires-Dist: mypy (>=0.900,<0.901) ; extra == "test"
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: pip (>=20.3.1,<21.0.0) ; extra == "dev"
Requires-Dist: pre-commit (>=2.12.0,<3.0.0) ; extra == "dev"
Requires-Dist: pytest (>=6.2.4,<7.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=2.12.0,<3.0.0) ; extra == "test"
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0) ; extra == "dev"
Requires-Dist: tox (>=3.20.1,<4.0.0) ; extra == "dev"
Requires-Dist: twine (>=3.3.0,<4.0.0) ; extra == "dev"
Requires-Dist: types-requests (>=2.31.0.10,<3.0.0.0) ; extra == "test"
Requires-Dist: virtualenv (>=20.2.2,<21.0.0) ; extra == "dev"
Project-URL: Homepage, https://github.com/grp-bork/meta_eukaryome_detect
Description-Content-Type: text/markdown

# meta_eukaryome_detect

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/grp-bork/meta_eukaryome_detect/main/docs/assets/logo-horizontal-on-dark.svg">
  <img alt="metaEukaryome" src="https://raw.githubusercontent.com/grp-bork/meta_eukaryome_detect/main/docs/assets/logo-horizontal.svg" width="360">
</picture>


[![pypi](https://img.shields.io/pypi/v/meta_eukaryome_detect.svg)](https://pypi.org/project/meta_eukaryome_detect/)
[![bioconda](https://img.shields.io/conda/vn/bioconda/meta_eukaryome_detect.svg)](https://anaconda.org/bioconda/meta_eukaryome_detect)
[![licence](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


Pathogen, Parasite, Eukaryote and Virus detection in metagenomes.

meta_eukaryome_detect is the package for **metaEukaryome**, which detects eukaryotes, viruses and
virulence genes in metagenomes. It maps the reads of a metagenomic sample against five references (PR2 18S rRNA,
mitochondrial genomes, plastid genomes, bacterial virulence factors and viral genomes) and reports
the coverage of each reference sequence detected.

## Quick start

```bash
conda install -c bioconda meta_eukaryome_detect
meta_eukaryome_detect download_db /path/to/db_dir
meta_eukaryome_detect run -i /path/to/sample_dir -d /path/to/db_dir -t 16 -p
```

`eukscan` is a shorter alias of the `meta_eukaryome_detect` command.

* Documentation: <https://grp-bork.embl-community.io/grp-microbiome-astrology/meta_eukaryome_detect/>
* GitHub: <https://github.com/grp-bork/meta_eukaryome_detect>
* PyPI: <https://pypi.org/project/meta_eukaryome_detect/>
* Free software: MIT

