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, 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.5 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.4.tar.gz (8.3 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.4-py3-none-any.whl (8.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sigprofilerassignment-1.1.4.tar.gz
Algorithm Hash digest
SHA256 78464eab6a7f98ec398e196ac9563d9402f9d490584b42ff220333a384dd7d0f
MD5 65127b74ae60ece0c5a73c9b7f9b89fc
BLAKE2b-256 84aa884059d4a5102ad53b15135c9c0c8d2c42e3b61a797ff5c797c8c132d846

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sigprofilerassignment-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d011f83dc0d0cc4ca98b2869564a1ef16e5bd8c92e4de3c3a33eb4ea426814cf
MD5 1f31445c6d516c300a602c4fd3eb4a6e
BLAKE2b-256 e98873160b0959bb7853c1ab06b36d62bcb6f537c74ee004504669eb6549578a

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