Skip to main content

Mutational signatures attribution and decomposition tool

Project description

Docs License CI

SigProfilerAssignment

SigProfilerAssignment

SigProfilerAssignment enables assignment of previously known mutational signatures to individual samples and individual somatic mutations. The tool refits different types of reference mutational signatures, including COSMIC signatures, as well as custom signature databases. SigProfilerAssignment makes use of SigProfilerMatrixGenerator and SigProfilerPlotting, seamlessly integrating with other in SigProfilerSuite.

Documentation

Detailed documentation can be found at https://sigprofilersuite.github.io/SigProfilerAssignment.

Quick Start Guide

Installation

Install the current stable PyPi version of SigProfilerAssignment:

$ pip install SigProfilerAssignment

If mutation calling files (MAF, VCF, or simple text files) are used as input, please install your desired reference genome as follows (available reference genomes are: GRCh37, GRCh38, mm9, mm10, mm39, rn6, and rn7):

$ python
from SigProfilerMatrixGenerator import install as genInstall
genInstall.install('GRCh37')

Running

Assignment of known mutational signatures to individual samples is performed using the cosmic_fit function. Input samples are provided using the samples parameter in the form of mutation calling files (VCFs, MAFs, or simple text files), segmentation files, or mutational matrices. COSMIC mutational signatures v3.6 are used as the default reference signatures, although previous COSMIC versions and custom signature databases are also supported using the cosmic_version and signature_database parameters. Results will be found in the folder specified in the output parameter.

from SigProfilerAssignment import Analyzer as Analyze
Analyze.cosmic_fit(samples, output, input_type="matrix", context_type="96")

You can also run SigProfilerAssignment cosmic_fit function from command line:

$ SigProfilerAssignment cosmic_fit samples output --input_type "matrix" --context_type "96"

Reference

Díaz-Gay M, Vangara R, Barnes M, et al., Alexandrov LB. Assigning mutational signatures to individual samples and individual somatic mutations with SigProfilerAssignment. Bioinformatics. 2023;39(12):btad756. https://doi.org/10.1093/bioinformatics/btad756

Contact

For questions, support requests, or bug reports, please contact the SigProfilerSuite team via GitHub issues or by email at contact@sigprofilersuite.org.

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

sigprofilerassignment-1.1.5.tar.gz (9.7 MB view details)

Uploaded Source

Built Distribution

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

sigprofilerassignment-1.1.5-py3-none-any.whl (10.0 MB view details)

Uploaded Python 3

File details

Details for the file sigprofilerassignment-1.1.5.tar.gz.

File metadata

  • Download URL: sigprofilerassignment-1.1.5.tar.gz
  • Upload date:
  • Size: 9.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.3

File hashes

Hashes for sigprofilerassignment-1.1.5.tar.gz
Algorithm Hash digest
SHA256 89d054ba7c3fa2b5d3fc401b7c8569fe746c257c97c7889fb8ce5ba5f40e7c2d
MD5 660352d2f374a3afa222b39cab8b4780
BLAKE2b-256 2fb769c25885a38456812b53b68c33fca6ea9fc03ad4335dc529d004b2ffb0c6

See more details on using hashes here.

File details

Details for the file sigprofilerassignment-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for sigprofilerassignment-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4773a69acabf49ee023c2468d3ff86473aa521c68a70843b6f28364182529d7c
MD5 8f092c05ea5e34dabbc3952cf75e2bc0
BLAKE2b-256 b66546199e075fc7cbd2477022744b5ce73845239ebea5025fbbd8c73dfdbb05

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