Skip to main content

A webapp and command line utility for identifying mutational hotspots

Project description

Status

efmcalculator is a Python package or web tool for detecting mutational hotspots. It predicts the mutation rates associated with each hotspot and combines them into a relative instability score. These hotspots include simple sequence repeats, repeat mediated deletions, and short repeat sequences. This code updates and improves upon the last version of the EFM calculator.

efmcalculator supports multifasta, genbank, or csv files as input and accepts parameters from the command line. It also supports the scanning of both linear and circular sequences. It defaults to a pairwise comparison strategy (all occurrences of a repeat are compared with all other occurrences), but it also contains an option for a linear comparison strategy (each occurrence of a repeat is only compared with the next occurrence in the sequence) to accelerate the analysis of large sequences.

Installation

The EFM Calculator can be accessed as a free web tool at efm2-beta.streamlit.app. It is limited to 50000 bases to ensure the app remains performant for other users. It can be installed and run locally below without such base restriction.

From pip:

pip install efmcalculator or clone this repository and pip install ./ from the root of the repository.

Command Line Usage

  • -h: help
  • -i: inpath
  • -o: outpath
  • -s: strategy. Either “linear” or “pairwise”
  • -c: circular inputs
  • -f: output filetype for tables, either csv or parquet
  • -j: threads
  • -t: tall. Parallelizes across inputs rather than within.
  • -v: verbose. 0 (silent), 1 (basic information), 2 (debug)
  • --summary: saves only aggrigate results, useful for very tall inputs

Print efmcalculator help:

efmcalculator -h

Run efmcalculator on all sequences in a FASTA file using the pairwise strategy and print output to csv files within an output folder:

efmcalculator -i “input.fasta” -o “output_folder”

Run efmcalculator on all sequences in a FASTA file, outputing to the folder output_folder, while treating the input as circular, searching with a linear pattern, and printing debug information:

efmcalculator -i “input.fasta” -o “output_folder” -c -s “linear” -v 2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

efmcalculator-0.0.post1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

efmcalculator-0.0.post1-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file efmcalculator-0.0.post1.tar.gz.

File metadata

  • Download URL: efmcalculator-0.0.post1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for efmcalculator-0.0.post1.tar.gz
Algorithm Hash digest
SHA256 73ee6f2142086423b8704b883d7c62692ab8cc0b191f212bcb72b12e9f18043a
MD5 9435a95dc062877834c071ba0554c225
BLAKE2b-256 5289f0151979eb196bb5cf866231a6562deb679e715cdc8bd2ed7d6a95cf7700

See more details on using hashes here.

Provenance

The following attestation bundles were made for efmcalculator-0.0.post1.tar.gz:

Publisher: publish_to_pypi.yml on barricklab/efm-calculator2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file efmcalculator-0.0.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for efmcalculator-0.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 730febaab3b08a2e70e848eae984d0cffccd03f49a140cca6baea43840c57981
MD5 ed4949424c5938261098b1b022a95a4a
BLAKE2b-256 828cd8d103d30d7a9e254c02f4ddaf5dc970d1bc44238a40c70ea2fc16634dbe

See more details on using hashes here.

Provenance

The following attestation bundles were made for efmcalculator-0.0.post1-py3-none-any.whl:

Publisher: publish_to_pypi.yml on barricklab/efm-calculator2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page