Skip to main content

A webapp and command line utility for identifying mutational hotspots

Project description

Stantus

efmcalculator2 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.

efmcalculator2 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 efmcalculator2 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 efmcalculator2 help:

efmcalculator2 -h

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

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

Run efmcalculator2 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:

efmcalculator2 -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

efmcalculator2-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.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: efmcalculator2-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 efmcalculator2-0.0.post1.tar.gz
Algorithm Hash digest
SHA256 425f738f14d6876059435f73a37ce536ef06b9c72fe05b0dfeee2ec6b02e744e
MD5 21da0d8d1373708228904738246c5cbd
BLAKE2b-256 f63f0e443c94be9f9f8a1c172e9d2c173406680a054a4490f4e4777d68f5de1f

See more details on using hashes here.

Provenance

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

Publisher: publish_to_pypi.yml on barricklab/efmcalculator2

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

File details

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

File metadata

File hashes

Hashes for efmcalculator2-0.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8f1e664915baf19561bae3303ec116b37a50919d3461fc758f8905cfc0a85b0
MD5 0b8180d90c827a003533d07a007bbeac
BLAKE2b-256 0c797f05d6dff0d599c705c267e0e2baa5017300b3e86eff143f234619bbebfc

See more details on using hashes here.

Provenance

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

Publisher: publish_to_pypi.yml on barricklab/efmcalculator2

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