Skip to content

BrucellaID 1.0.0

Choose a tag to compare

@duceppemo duceppemo released this 31 Oct 21:23
· 86 commits to main since this release

BrucellaID becomes an installable, tested package. It answers the same two questions as the first version —
which Brucella species a read set is, and which sequence type — and answers the first one exactly as before.

Install

conda create -n brucellaid -c conda-forge -c bioconda brucellaid   # once the bioconda recipe is merged
# or
pip install brucellaid                                              # MASH and BBTools from bioconda

What changed

  • The two OLC dependencies are gone: accessoryFunctions (OLCTools) and MLSTsippr (sipprverse). Neither
    installs from PyPI, so neither could be packaged. BrucellaID now needs nothing but the Python standard
    library, plus MASH and BBTools.
  • The MLST database is in the package, so -d is gone; the input is -r1/-r2 or -i, instead of -s.
  • The MLST alleles are called with Seal from BBTools, and the database is PubMLST's: 309 alleles and 122
    sequence types, where vSNP's copy had 263 and 81. That copy had drifted — it still held a gyrB_23 that
    PubMLST has deleted, and that sequence matched the B. abortus 9-941 genome better than the real gyrB_1,
    turning ST 1 into a new profile.
  • The species identification is unchanged in substance: the same 16 vSNP reference genomes, the same sketch,
    the same threshold of 150 shared hashes out of 1000. New around it: the distance to every reference, the
    species/biovar/strain/accessions of each, and a note when a second reference was nearly as close.
  • Four reports — one row per sample, one per locus, every MASH distance, and a JSON report — and --xlsx
    still writes stat_alignment_summary_<date>.xlsx for whatever reads it.
  • 194 tests at 100% coverage, on Python 3.10, 3.12 and 3.14; a wiki; a tutorial on four public read sets.
  • Validated on 16 genomes with a known answer: every species, biovar and closest reference right, all 14
    sequence types the one the genome carries, and the nearest neighbouring species (B. anthropi) reported
    as not identified at 4 shared hashes of 1000.

The 193 MB of per-reference vSNP script_dependents folders are no longer in the repository; they remain in
the history and in the v0.1 release.

Full changelog: https://github.com/duceppemo/BrucellaID/wiki/Changelog