Skip to main content

GRAMEP - Genome vaRiation Analysis from the Maximum Entropy Principle

Project description

GRAMEP - Genome vaRiation Analysis from the Maximum Entropy Principle

Documentation Status codecov CI pypi

GRAMEP is a powerful, Python-based tool designed for the precise identification of Single Nucleotide Polymorphisms (SNPs) within biological sequences. It goes beyond basic SNP identification, offering advanced functionalities including:

  • Intersection analysis: Analyze mutations found in different variants to identify shared mutations.
  • Classification model training: Train a classification model to predict the class of new sequences.

GRAMEP is accessible through a robust and intuitive Command-Line Interface (CLI). The primary command is gramep, with sub-commands for each action the application can perform.

For detailed information, access the documentation.

How to install

The use of pipx is recommended for installing GRAMEP:

pipx install gramep

Although this is only a recommendation, you can also install the project with the manager of your choice. For example, pip:

pip install gramep

Quick Guide

Identifying the most informative SNPs

To identify the most informative Single Nucleotide Polymorphisms (SNPs) using GRAMEP, you will utilize the get-mutations command. Below, you will find the basic usage of this command:

gramep get-mutations [OPTIONS]

For detailed information on available options and how to use them, simply enter the following command:

gramep get-mutations --help

This will provide you with comprehensive guidance on how to make the most of the get-mutations command, allowing you to efficiently analyze and extract valuable SNPs from your biological sequences.

Identifying Mutation Intersection Between Variants

To identify the intersection of mutations present in two or more variants of the same organism, you can utilize the `get-intersection`` command provided by GRAMEP. Below, we outline the basic usage of this command:

gramep get-intersection [OPTIONS]

This command allows you to analyze and find common mutations shared among multiple variant sequences. For detailed information on available options and how to make the most of the get-intersection command, simply use the --help flag:

gramep get-intersection --help

Classifying Biological Sequences

To classify biological sequences using GRAMEP, you can utilize the classify command. Here is the basic usage of this command:

gramep classify [OPTIONS]

This command allows you to perform sequence classification tasks with ease. For detailed information on available options and how to use them effectively, use the --help flag:

gramep classify --help

Predicting Biological Sequences

The predict command of GRAMEP is used to perform class predictions on new biological sequences after training a classification model. Below, you'll find the basic usage of this command:

gramep predict [OPTIONS]

This command allows you to leverage your trained classification model to predict the classes of new biological sequences. For detailed information on available options and how to use them effectively, utilize the --help flag:

gramep predict --help

Citation

Soon

Acknowledgements
  • This study was financed in part by the Coordenação de Aperfeiçoamento de Pessoal de Nível Superior - Brasil (CAPES) - Finance Code 001, the Fundação Araucária, Governo do Estado do Paraná/SETI (Grant number 035/2019, 138/2021 and NAPI - Bioinformática).

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

gramep-1.2.1.tar.gz (49.2 MB view details)

Uploaded Source

Built Distribution

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

gramep-1.2.1-cp312-cp312-manylinux_2_34_x86_64.whl (1.1 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

File details

Details for the file gramep-1.2.1.tar.gz.

File metadata

  • Download URL: gramep-1.2.1.tar.gz
  • Upload date:
  • Size: 49.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.7.1

File hashes

Hashes for gramep-1.2.1.tar.gz
Algorithm Hash digest
SHA256 688b59daa2e20c5ef6297a06cf68b51ec8facd793d1f22bf75bb244698e65b8a
MD5 78626f8d1ff06e86e6b291ce131263e4
BLAKE2b-256 52e8e5d4785d630193a0c9026a1498dfcbe24cb5fcba1dd1fa556f547d992a52

See more details on using hashes here.

File details

Details for the file gramep-1.2.1-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for gramep-1.2.1-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 63ab02bd7985b309d439b561f33c30fe269ef56d1de7d4805e496166b9da3560
MD5 1ccff9576d6650167fdf477e6477c42a
BLAKE2b-256 5e8a31c3516811439556f67935b8972addd0c2883a29c2ceb6e99cf8d05c3e6e

See more details on using hashes here.

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