Learn R Programming

⚠️There's a newer version (2.3.1) of this package.Take me there.

Sigminer: Mutational Signature Analysis and Visualization in R

:bar_chart: Overview

The cancer genome is shaped by various mutational processes over its lifetime, stemming from exogenous and cell-intrinsic DNA damage, and error-prone DNA replication, leaving behind characteristic mutational spectra, termed mutational signatures. This package, sigminer, helps users to extract, analyze and visualize signatures from genome alteration records, thus providing new insight into cancer study.

For pipeline tool, please see its co-evolutionary CLI sigflow.

SBS signatures:

Copy number signatures:

DBS signatures:

INDEL (i.e. ID) signatures:

Genome rearrangement signatures:

:airplane: Features

  • supports a standard de novo pipeline for identification of 5 types of signatures: copy number, SBS, DBS, INDEL and RS (genome rearrangement signature).
  • supports quantify exposure for one sample based on known signatures.
  • supports association and group analysis and visualization for signatures.
  • supports two types of signature exposures: relative exposure (relative contribution of signatures in each sample) and absolute exposure (estimated variation records of signatures in each sample).
  • supports basic summary and visualization for profile of mutation (powered by maftools) and copy number.
  • supports parallel computation by R packages foreach, future and NMF.
  • efficient code powered by R packages data.table and tidyverse.
  • elegant plots powered by R packages ggplot2, ggpubr, cowplot and patchwork.
  • well tested by R package testthat and documented by R package roxygen2, roxytest, pkgdown, and etc. for both reliable and reproducible research.

:arrow_double_down: Installation

You can install the stable release of sigminer from CRAN with:

install.packages("BiocManager")
BiocManager::install("sigminer", dependencies = TRUE)

You can install the development version of sigminer from Github with:

remotes::install_github("ShixiangWang/sigminer", dependencies = TRUE)
# For Chinese users, run 
remotes::install_git("https://gitee.com/ShixiangWang/sigminer", dependencies = TRUE)

You can also install sigminer from conda bioconda channel with

# Please note version number of the bioconda release

# You can install an individual environment firstly with
# conda create -n sigminer
# conda activate sigminer
conda install -c bioconda -c conda-forge r-sigminer

:beginner: Usage

A complete documentation of sigminer can be read online at https://shixiangwang.github.io/sigminer-book/. All functions are well organized and documented at https://shixiangwang.github.io/sigminer/reference/index.html. For usage of a specific function fun, run ?fun in your R console to see its documentation.

:paperclip: Citation

If you use sigminer in academic field, please cite one of the following papers.


  • Wang S, Li H, Song M, Tao Z, Wu T, He Z, et al. (2021) Copy number signature analysis tool and its application in prostate cancer reveals distinct mutational processes and clinical outcomes. PLoS Genet 17(5): e1009557. https://doi.org/10.1371/journal.pgen.1009557
  • Wang, S., Tao, Z., Wu, T., & Liu, X. S. (2021). Sigflow: an automated and comprehensive pipeline for cancer genome mutational signature analysis. Bioinformatics, 37(11), 1590-1592. https://doi.org/10.1093/bioinformatics/btaa895
  • Ziyu Tao, Shixiang Wang, Chenxu Wu, Tao Wu, Xiangyu Zhao, Wei Ning, Guangshuai Wang, Jinyu Wang, Jing Chen, Kaixuan Diao, Fuxiang Chen, Xue-Song Liu, The repertoire of copy number alteration signatures in human cancer, Briefings in Bioinformatics, 2023, bbad053. https://doi.org/10.1093/bib/bbad053

:arrow_down: Download Stats

:page_with_curl: References

Please properly cite the following references when you are using any corresponding features. The references are also listed in the function documentation. Very thanks to the works, sigminer cannot be created without the giants.

  1. Mayakonda, Anand, et al. “Maftools: efficient and comprehensive analysis of somatic variants in cancer.” Genome research 28.11 (2018): 1747-1756.
  2. Gaujoux, Renaud, and Cathal Seoighe. “A Flexible R Package for Nonnegative Matrix Factorization.”” BMC Bioinformatics 11, no. 1 (December 2010).
  3. H. Wickham. ggplot2: Elegant Graphics for Data Analysis. Springer-Verlag New York, 2016.
  4. Kim, Jaegil, et al. “Somatic ERCC2 mutations are associated with a distinct genomic signature in urothelial tumors.” Nature genetics 48.6 (2016): 600.
  5. Alexandrov, Ludmil B., et al. “Deciphering signatures of mutational processes operative in human cancer.” Cell reports 3.1 (2013): 246-259.
  6. Degasperi, Andrea, et al. “A practical framework and online tool for mutational signature analyses show intertissue variation and driver dependencies.” Nature cancer 1.2 (2020): 249-263.
  7. Alexandrov, Ludmil B., et al. “The repertoire of mutational signatures in human cancer.” Nature 578.7793 (2020): 94-101.
  8. Macintyre, Geoff, et al. “Copy number signatures and mutational processes in ovarian carcinoma.” Nature genetics 50.9 (2018): 1262.
  9. Tan, Vincent YF, and Cédric Févotte. “Automatic relevance determination in nonnegative matrix factorization with the/spl beta/-divergence.” IEEE Transactions on Pattern Analysis and Machine Intelligence 35.7 (2012): 1592-1605.
  10. Bergstrom EN, Huang MN, Mahto U, Barnes M, Stratton MR, Rozen SG, Alexandrov LB: SigProfilerMatrixGenerator: a tool for visualizing and exploring patterns of small mutational events. BMC Genomics 2019, 20:685 https://bmcgenomics.biomedcentral.com/articles/10.1186/s12864-019-6041-2

:page_facing_up: LICENSE

The software is made available for non commercial research purposes only under the MIT. However, notwithstanding any provision of the MIT License, the software currently may not be used for commercial purposes without explicit written permission after contacting patents’ authors.

Related patents:

  • CN202011516653.7 https://kms.shanghaitech.edu.cn/handle/2MSLDSTB/127042

MIT © 2019-Present Shixiang Wang, Xue-Song Liu

MIT © 2018 Anand Mayakonda


Sigminer v1-v2 are supported by Cancer Biology Group @ShanghaiTech

Copy Link

Version

Install

install.packages('sigminer')

Monthly Downloads

395

Version

2.3.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Shixiang Wang

Last Published

December 12th, 2023

Functions in sigminer (2.3.0)

MAF-class

Class MAF
add_labels

Add Text Labels to a ggplot
CN.features

Classification Table of Copy Number Features Devised by Wang et al. for Method 'W'
add_h_arrow

Add Horizontal Arrow with Text Label to a ggplot
cosine

Calculate Cosine Measures
cytobands.T2T

Location of Chromosome Cytobands at Genome Build T2T
cytobands.hg19

Location of Chromosome Cytobands at Genome Build hg19
cytobands.hg38

Location of Chromosome Cytobands at Genome Build hg38
centromeres.mm10

Location of Centromeres at Genome Build mm10
enrich_component_strand_bias

Performs Strand Bias Enrichment Analysis for a Given Sample-by-Component Matrix
chromsize.mm10

Chromosome Size of Genome Build mm10
centromeres.T2T

Location of Centromeres at Genome Build T2T
chromsize.mm9

Chromosome Size of Genome Build mm9
get_Aneuploidy_score

Get Aneuploidy Score from Copy Number Profile
bp

A Best Practice for Signature Extraction and Exposure (Activity) Attribution
hello

Say Hello to Users
get_adj_p

Get Adjust P Values from Group Comparison
get_cn_freq_table

Get CNV Frequency Table
get_bayesian_result

Get Specified Bayesian NMF Result from Run
output_bootstrap

Output Signature Bootstrap Fitting Results
get_cn_ploidy

Get Ploidy from Absolute Copy Number Profile
get_groups

Get Sample Groups from Signature Decomposition Information
get_intersect_size

Get Overlap Size between Interval x and y
cytobands.mm10

Location of Chromosome Cytobands at Genome Build mm10
centromeres.hg19

Location of Centromeres at Genome Build hg19
read_sv_as_rs

Read Structural Variation Data as RS object
cytobands.mm9

Location of Chromosome Cytobands at Genome Build mm9
read_copynumber

Read Absolute Copy Number Profile
get_sig_cancer_type_index

Obtain Signature Index for Cancer Types
centromeres.mm9

Location of Centromeres at Genome Build mm9
chromsize.T2T

Chromosome Size of Genome Build T2T
get_sig_rec_similarity

Get Reconstructed Profile Cosine Similarity, RSS, etc.
get_sig_db

Get Curated Reference Signature Database
get_sig_similarity

Calculate Similarity between Identified Signatures and Reference Signatures
CopyNumber-class

Class CopyNumber
read_copynumber_ascat

Read Copy Number Data from ASCAT Result Files
get_genome_annotation

Get Genome Annotation
chromsize.hg19

Chromosome Size of Genome Build hg19
get_group_comparison

Get Comparison Result between Signature Groups
chromsize.hg38

Chromosome Size of Genome Build hg38
get_pLOH_score

Get proportions of pLOH score from Allele Specific Copy Number Profile
read_vcf

Read VCF Files as MAF Object
output_fit

Output Signature Fitting Results
output_sig

Output Signature Results
get_sig_exposure

Get Signature Exposure from 'Signature' Object
get_shannon_diversity_index

Get Shannon Diversity Index for Signatures
show_cn_components

Show Copy Number Components
show_cn_distribution

Show Copy Number Distribution either by Length or Chromosome
get_tidy_association

Get Tidy Signature Association Results
show_group_mapping

Map Groups using Sankey
show_sig_bootstrap

Show Signature Bootstrap Analysis Results
group_enrichment2

Group Enrichment Analysis with Subsets
read_xena_variants

Read UCSC Xena Variant Format Data as MAF Object
handle_hyper_mutation

Handle Hypermutant Samples
show_groups

Show Signature Contribution in Clusters
same_size_clustering

Same Size Clustering
scoring

Score Copy Number Profile
report_bootstrap_p_value

Report P Values from bootstrap Results
show_sig_fit

Show Signature Fit Result
group_enrichment

General Group Enrichment Analysis
show_sig_profile

Show Signature Profile
show_catalogue

Show Alteration Catalogue Profile
sig_tally

Tally a Genomic Alteration Object
show_cor

A Simple and General Way for Association Analysis
read_copynumber_seqz

Read Absolute Copy Number Profile from Sequenza Result Directory
sig_unify_extract

An Unified Interface to Extract Signatures
transcript.mm9

Merged Transcript Location at Genome Build mm9
read_maf

Read MAF Files
show_cn_features

Show Copy Number Feature Distributions
get_sig_feature_association

Calculate Association between Signature Exposures and Other Features
output_tally

Output Tally Result in Barplots
show_cn_freq_circos

Show Copy Number Variation Frequency Profile with Circos
show_cosmic_sig_profile

Plot Reference (Mainly COSMIC) Signature Profile
%>%

Pipe operator
show_sig_consensusmap

Show Signature Consensus Map
show_group_comparison

Plot Group Comparison Result
transform_seg_table

Transform Copy Number Table
sig_auto_extract

Extract Signatures through the Automatic Relevance Determination Technique
sig_convert

Convert Signatures between different Genomic Distribution of Components
show_cn_circos

Show Copy Number Profile in Circos
show_cn_group_profile

Show Summary Copy Number Profile for Sample Groups
show_sig_exposure

Plot Signature Exposure
show_sig_profile_heatmap

Show Signature Profile with Heatmap
show_cosmic

Show Signature Information in Web Browser
show_group_distribution

Show Groupped Variable Distribution
show_cn_profile

Show Sample Copy Number Profile
show_sig_feature_corrplot

Draw Corrplot for Signature Exposures and Other Features
sig_fit

Fit Signature Exposures with Linear Combination Decomposition
show_sig_profile_loop

Show Signature Profile with Loop Way
simulated_catalogs

A List of Simulated SBS-96 Catalog Matrix
show_group_enrichment

Show Group Enrichment Result
sig_fit_bootstrap

Obtain Bootstrap Distribution of Signature Exposures of a Certain Tumor Sample
sig_fit_bootstrap_batch

Exposure Instability Analysis of Signature Exposures with Bootstrapping
simulation

Simulation Analysis
sigminer-package

sigminer: Extract, Analyze and Visualize Signatures for Genomic Variations
sigprofiler

Extract Signatures with SigProfiler
sig_operation

Obtain or Modify Signature Information
sig_estimate

Estimate Signature Number
transcript.hg38

Merged Transcript Location at Genome Build hg38
sig_extract

Extract Signatures through NMF
transcript.mm10

Merged Transcript Location at Genome Build mm10
subset.CopyNumber

Subsetting CopyNumber object
tidyeval

Tidy eval helpers
transcript.T2T

Merged Transcript Location at Genome Build T2T
use_color_style

Set Color Style for Plotting
transcript.hg19

Merged Transcript Location at Genome Build hg19
centromeres.hg38

Location of Centromeres at Genome Build hg38