Sovereign 8s.is mirror of standardgalactic/CenStats
  • Python 99.1%
  • Makefile 0.9%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Keith Oshima 33d62253e7
Some checks failed
CI / test (push) Has been cancelled
Merge pull request #29 from logsdon-lab/feature/kmer-entropy
feat: kmer entropy
2025-10-28 21:54:35 -04:00
.github/workflows Add venv activation for integration tests. 2025-01-15 00:53:04 -05:00
censtats Update README and docstrings. 2025-10-27 03:16:19 -04:00
test Add kmer-entropy subcommand to calculate windowed shannon entropy based on kmer set. 2025-10-26 22:44:58 -04:00
.gitattributes Add kmer-entropy subcommand to calculate windowed shannon entropy based on kmer set. 2025-10-26 22:44:58 -04:00
.gitignore Fix missing parameter. 2025-01-15 00:07:23 -05:00
.pre-commit-config.yaml First commit. 2024-02-27 23:44:25 -05:00
LICENSE Fixed ref name not being chr. Added restrict chr13/21 and chr14/22 options. Reworked acro p and q arm detection functions. Factored in length of q-arm into edit distance calculation only for q-arm of acrocentric chromosomes. Added MIT license. Added plots and script for test result visualization. 2024-05-14 08:49:01 -04:00
Makefile Make requirements less strict. Bump version. 2025-09-01 02:27:43 -04:00
pyproject.toml Add kmer-entropy subcommand to calculate windowed shannon entropy based on kmer set. 2025-10-26 22:44:58 -04:00
README.md Update README and docstrings. 2025-10-27 03:16:19 -04:00
requirements.txt Remove status subcommand due to lack of use. Bump version. 2025-09-11 02:40:02 -04:00

CenStats

CI PyPI - Version

Centromere statistics toolkit.

  • length
  • nonredundant
    • Get a non-redundant list of centromeres based on HOR array length from two AS-HOR array length lists. Uses output from length command.
  • entropy
    • Calculate Shannon index across a region from RepeatMasker repeats.
  • self-ident
    • Calculate 1D or 2D self-sequence average nucleotide identity via a k-mer-based containment index. Built from ModDotPlot's source code.
  • kmer-entropy
    • Calculate Shannon index from a fasta file across all windows and their kmer set.

Setup

pip install censtats

Usage

usage: censtats [-h] {length,nonredundant,entropy,self-ident,kmer-entropy} ...

Centromere statistics toolkit.

positional arguments:
  {length,nonredundant,entropy,self-ident,kmer-entropy}

options:
  -h, --help            show this help message and exit

Read the docs here.

Build

make venv && make build && make install
source venv/bin/activate && censtats -h

To run tests:

source venv/bin/activate && pip install pytest
pytest -s -vv