mdeq


Namemdeq JSON
Version 2025.6.30 PyPI version JSON
download
home_pageNone
Summarymdeq: mutation disequilibrium analysis tools.
upload_time2025-08-13 07:11:57
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseNone
keywords biology genomics statistics phylogeny evolution bioinformatics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Coverage Status](https://coveralls.io/repos/github/HuttleyLab/MutationDiseq/badge.svg)](https://coveralls.io/github/HuttleyLab/MutationDiseq)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

# mdeq: a tool for analysing mutation disequilibrium

A manuscript describing the methods will be made available as a preprint soon.

## Installation

```
$ pip install mdeq
```

> **Note**
> `accupy` is an optional package for the most numerically accurate routines involving matrices (e.g. dot products). These routines are explicitly employed for computing the nabla related statistics and are used if this package is installed. Unfortunately it is not easily installed and (at the time of writing) is not under active development.

## The available commands

<!-- [[[cog
import cog
from mdeq import main
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(main, ["--help"])
help = result.output.replace("Usage: main", "Usage: mdeq")
cog.out(
    "```\n{}\n```".format(help)
)
]]] -->
```
Usage: mdeq [OPTIONS] COMMAND [ARGS]...

  mdeq: mutation disequilibrium analysis tools.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  tui              Open Textual TUI.
  prep             pre-process alignment data.
  make-adjacent    makes sqlitedb of adjacent alignment records.
  toe              test of existence of mutation equilibrium.
  teop             between branch equivalence of mutation process test
  aeop             between loci equivalence of mutation process test
  convergence      estimates convergence towards mutation equilibrium.
  make-controls    simulate negative and positive controls
  db-summary       displays summary information about a db
  extract-pvalues  extracts p-values from TOE sqlitedb results
  extract-nabla-c  extracts nabla-c from convergence sqlitedb results
  slide            generate window sized sub-alignments.

```
<!-- [[[end]]] -->


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mdeq",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": null,
    "keywords": "biology, genomics, statistics, phylogeny, evolution, bioinformatics",
    "author": null,
    "author_email": "Katherine Caley <katherine.caley@anu.edu.au>, Gavin Huttley <Gavin.Huttley@anu.edu.au>",
    "download_url": "https://files.pythonhosted.org/packages/40/e6/7a3bca3f7e8d66bfbf851dca77d8fdf84ccb550afa9c1b70f5c87677d433/mdeq-2025.6.30.tar.gz",
    "platform": null,
    "description": "[![Coverage Status](https://coveralls.io/repos/github/HuttleyLab/MutationDiseq/badge.svg)](https://coveralls.io/github/HuttleyLab/MutationDiseq)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n# mdeq: a tool for analysing mutation disequilibrium\n\nA manuscript describing the methods will be made available as a preprint soon.\n\n## Installation\n\n```\n$ pip install mdeq\n```\n\n> **Note**\n> `accupy` is an optional package for the most numerically accurate routines involving matrices (e.g. dot products). These routines are explicitly employed for computing the nabla related statistics and are used if this package is installed. Unfortunately it is not easily installed and (at the time of writing) is not under active development.\n\n## The available commands\n\n<!-- [[[cog\nimport cog\nfrom mdeq import main\nfrom click.testing import CliRunner\nrunner = CliRunner()\nresult = runner.invoke(main, [\"--help\"])\nhelp = result.output.replace(\"Usage: main\", \"Usage: mdeq\")\ncog.out(\n    \"```\\n{}\\n```\".format(help)\n)\n]]] -->\n```\nUsage: mdeq [OPTIONS] COMMAND [ARGS]...\n\n  mdeq: mutation disequilibrium analysis tools.\n\nOptions:\n  --version  Show the version and exit.\n  --help     Show this message and exit.\n\nCommands:\n  tui              Open Textual TUI.\n  prep             pre-process alignment data.\n  make-adjacent    makes sqlitedb of adjacent alignment records.\n  toe              test of existence of mutation equilibrium.\n  teop             between branch equivalence of mutation process test\n  aeop             between loci equivalence of mutation process test\n  convergence      estimates convergence towards mutation equilibrium.\n  make-controls    simulate negative and positive controls\n  db-summary       displays summary information about a db\n  extract-pvalues  extracts p-values from TOE sqlitedb results\n  extract-nabla-c  extracts nabla-c from convergence sqlitedb results\n  slide            generate window sized sub-alignments.\n\n```\n<!-- [[[end]]] -->\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "mdeq: mutation disequilibrium analysis tools.",
    "version": "2025.6.30",
    "project_urls": null,
    "split_keywords": [
        "biology",
        " genomics",
        " statistics",
        " phylogeny",
        " evolution",
        " bioinformatics"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "af90b12671c376015b66513bc15e8103046b51e8ad442b50dd3b554fbe2258fc",
                "md5": "1c6bab6e87c89213178144d48e343da0",
                "sha256": "9681208c056bcb3b3ac4edaafc4163f6d557ca00726c505136bf75ba96a4bf04"
            },
            "downloads": -1,
            "filename": "mdeq-2025.6.30-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1c6bab6e87c89213178144d48e343da0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 32670,
            "upload_time": "2025-08-13T07:11:56",
            "upload_time_iso_8601": "2025-08-13T07:11:56.405799Z",
            "url": "https://files.pythonhosted.org/packages/af/90/b12671c376015b66513bc15e8103046b51e8ad442b50dd3b554fbe2258fc/mdeq-2025.6.30-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "40e67a3bca3f7e8d66bfbf851dca77d8fdf84ccb550afa9c1b70f5c87677d433",
                "md5": "b8e0f3873887e12087fa23e6ed77f6b9",
                "sha256": "b2555feb05fbb3a35568938f11477fe2f220f826ad58dca4e71541e762ba551f"
            },
            "downloads": -1,
            "filename": "mdeq-2025.6.30.tar.gz",
            "has_sig": false,
            "md5_digest": "b8e0f3873887e12087fa23e6ed77f6b9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.10",
            "size": 27742,
            "upload_time": "2025-08-13T07:11:57",
            "upload_time_iso_8601": "2025-08-13T07:11:57.764386Z",
            "url": "https://files.pythonhosted.org/packages/40/e6/7a3bca3f7e8d66bfbf851dca77d8fdf84ccb550afa9c1b70f5c87677d433/mdeq-2025.6.30.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 07:11:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mdeq"
}
        
Elapsed time: 0.72427s