Skip to content

Repository files navigation

bioquik

bioquik is a fast and extensible command-line toolkit for counting CG-anchored DNA motifs in FASTA files. Designed to accelerate bioinformatics pipelines with a simple and parallel interface.

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Docs GitHub license Build Status codecov Ruff

Publish PyPI - Version TestPyPI Python Versions Keep a Changelog Contributor Covenant

Features

  • Expand wildcard patterns (e.g. **CG**) into exact motifs
  • Count motifs using a memory-efficient FM-index
  • Parallel processing of multiple FASTA files
  • Generates:
    • Per-file CSVs
    • Combined summary CSV
    • Optional JSON summary
    • Optional plots (motif distribution, frequency heatmap)
  • Rich progress indicators
  • Fully tested with Pytest

Installation

For users (latest release from PyPI):

pip install bioquik

For developers (editable mode + dev dependencies):

git clone https://github.com/Rajkanwars15/bioquik
cd bioquik
pip install -e '.[dev,docs]'

Requirements

  • Python ≥ 3.9
  • Linux/macOS (tested); Windows should work with minor path adjustments

Documentation

Full docs are hosted on Read the Docs.

For Users

For Developers

License

This project is licensed under the terms of the MIT License.

Author

Static Badge

About

Fast FM-index toolkit for CG-anchored DNA motif counting in FASTA files with parallel processing and optional visualization.

Topics

Resources

Code of conduct

Contributing

Stars

2 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages