MarkerFinder
Adaptive HGT-Aware Phylogenomic Pipeline for Prokaryotic Marker Gene Selection
English README | 中文说明 | Manual (EN) | Manual (CN)
Documentation in this repository ships in both languages, with the English version as the primary text.
tests/unit/test_docs_are_bilingual.pyfails if a document exists in only one language, if an "English" file is written in Chinese, or if the two versions diverge in shape.
Overview
MarkerFinder is a phylogenomic pipeline for prokaryotic marker gene selection and species tree inference. It targets three common challenges in existing methods:
- Rigid marker sets — MarkerFinder dynamically selects optimal markers adapted to your dataset
- HGT contamination — phylogenetic-only horizontal gene transfer screening removes phylogenetically misleading markers
- MAG fragility — quality-aware adaptive parameters handle incomplete metagenome-assembled genomes
Conceptual Origin
MarkerFinder's integrative (concatenation + coalescence) marker-consistency idea is methodologically derived from Steenwyk & King (2025), Science 390, 751–756, doi:10.1126/science.adw9456 — a paper retracted at the authors' own request on 2026-02-05 (retraction notice: Science 391, 564, doi:10.1126/science.aef5589). The retraction concerns the paper's biological conclusion, not its methodological framework; MarkerFinder borrows only the latter and implements, evaluates and defends it independently. See README.EN.md § Conceptual Origin (中文) for the full citation and the element-by-element mapping into this codebase.
Quick Start
# Install (into an environment that also has the external tools)
conda env create -f environment.yml
pip install -e ".[dev]"
# Run
markerfinder \
-i genomes/ \
-o output/ \
-t 8 \
--mode standard \
--gtdb-markers-dir gtdbtk_out/align/marker_genes
Documentation
| Document | English | Chinese |
|---|---|---|
| Full README (features, parameters, outputs) | README.EN.md | README.CN.md |
| Manual (formats, schemas, troubleshooting) | MANUAL.EN.md | MANUAL.CN.md |
| Reference databases (what is fetched, not shipped) | db/README.md | db/README.md |
| Test plan & validation methodology | docs/TESTING.EN.md | docs/TESTING.CN.md |
| Test report (measured results) | docs/TEST-REPORT.EN.md | docs/TEST-REPORT.CN.md |
| Validation suite (data, cases, archived results) | validation/README.EN.md | validation/README.CN.md |
| External benchmark & positive controls | tests/benchmark/README.EN.md | tests/benchmark/README.CN.md |
Testing
The repository carries three test layers. The first two are fast and self-contained; the third runs the real pipeline on real data and is the acceptance evidence published with the release.
| Layer | What it does | How to run |
|---|---|---|
tests/unit/, tests/integration/ |
logic, parsing, schemas, wiring; external tools mocked | pytest tests |
tests/benchmark/ |
contract tests for the external-benchmark driver (no GB download) | pytest tests/benchmark |
validation/ |
full-feature, full-workflow runs on real genomes, with measured detection metrics | python validation/run_validation.py --all -n 8 |
validation/capabilities.py + validation/cases/test_v90_capability_coverage.py
make coverage checkable: every option, subcommand, exit code and output product
the software advertises is enumerated from the code, and any entry without a
case fails the suite. The exported matrix lives in
validation/results/capability_matrix.tsv.
Author
Zengzichao (曾子超) — zengzichao@sjtu.edu.cn · ORCID 0000-0001-6553-970X
License
Metadata
Release files for markerfinder 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| markerfinder-0.1.1.tar.gz | 226.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| markerfinder-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 479.8 kB
Release files / markerfinder-0.1.1.tar.gz
| Download URL | markerfinder-0.1.1.tar.gz |
|---|---|
| Size | 226.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
330e317272dbd620ce6e53a0f104959f82f1caab95fc05f86faa0b733926384e
|
|
BLAKE2b-256 checksum How to use checksums |
29c3b610c5f38e41a1f153a79f4d163ff7bf8307ca07f8c4e5aef9a92617420a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 18, 2026.
Transparency logRelease files / markerfinder-0.1.1-py3-none-any.whl
| Download URL | markerfinder-0.1.1-py3-none-any.whl |
|---|---|
| Size | 253.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c5dc83597b014a6269d582fe05e9d07fefaad4b0b4b32a4195fcb837f86444e3
|
|
BLAKE2b-256 checksum How to use checksums |
62c89bde999856ab002d53295fb553d8d9a4d1835344285941588acefa263490
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 18, 2026.
Transparency log