• Stars
    star
    142
  • Rank 258,495 (Top 6 %)
  • Language
    R
  • License
    Other
  • Created almost 6 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🌲 An easy-to-use and scalable toolkit for genomic alteration signature (a.k.a. mutational signature) analysis and visualization in R https://shixiangwang.github.io/sigminer/reference/index.html

Sigminer: Mutational Signature Analysis and Visualization in R logo

CRAN status lifecycle R-CMD-check Closed issues Hits install with bioconda check in Biotreasury

📊 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:

✈️ 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.

⏬ 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

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

📎 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

⬇️ Download Stats

📃 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

📄 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

Alt

More Repositories

1

pybook

《交互的Python:数据分析入门》
103
star
2

Handbook_of_biostatistic_R

📗handbook of biostatistic and R
HTML
62
star
3

install_GISTIC

Install GISTIC2 by one line code; GISTIC2 docker image
Shell
40
star
4

DoAbsolute

📦 Automate Absolute Copy Number Calling using 'ABSOLUTE' package
R
36
star
5

self-study

My Self-Study Room: keep tidy and lightweight
HTML
30
star
6

Variants2Neoantigen

A neoantigen calling pipeline begins from variants record file (MAF) (Not maintain now)
Shell
29
star
7

sigflow

Sigflow: Streamline Analysis Workflows for Mutational Signatures, https://github.com/ShixiangWang/sigflow/pkgs/container/sigflow
R
26
star
8

masterR

📓R学习笔记与进阶之道
Jupyter Notebook
24
star
9

geek-r-tutorial

极客R:数据分析之道
TeX
23
star
10

sync2gitee

Auto-Sync GitHub Repositories to Gitee
22
star
11

sync-deploy

🔄 shell toolkit for deploying script/command task on remote host, including up/download files, run script on remote
Shell
21
star
12

ezcox

Easily Process a Batch of Cox Models
R
20
star
13

Git-Handbook

Git使用手册
16
star
14

gcap

GCAP (Gene-level Circular Amplicon Prediction) firstly implements extrachromosomal DNA detection from whole-exome-sequencing (WES) data and absolute copy number profiles. https://shixiangwang.r-universe.dev/gcap
R
15
star
15

r-search-extension

The ultimate search extension for R
JavaScript
15
star
16

copynumber

The "copynumber" R package with support for hg38
R
15
star
17

next-blog

♨️Personal blog website, will not update anymore. https://shixiangwang.github.io is new site
JavaScript
10
star
18

home

王诗翔(Shixiang Wang)的个人网站
HTML
9
star
19

polar

polar: Dots and Their Connections in Polar Coordinate System
R
9
star
20

VSHunter

Capture Copy Number and Mutation Signatures
R
8
star
21

tinyscholar

A Tiny R Package to Get and Show Google Scholar Profile
R
8
star
22

IDConverter

Convert Identifiers in Biological Databases
R
8
star
23

sigminer.prediction

Train and Predict Cancer Subtype with Keras Model based on Mutational Signatures
R
8
star
24

metawho

📦 An R package implementing deft approach for meta analysis
R
7
star
25

flymaps

Convenient keymaps for data science work with Python, R, Markdown and Rmarkdown in VS Code
Shell
7
star
26

regport

Regression Model Processing Port
R
6
star
27

learn-devel-Rpkg

非参解析与R包创建学习实战
R
6
star
28

Linux_Practice

Linux练习题 - 生信入门
6
star
29

shinyapps

My Open-Source Shiny Apps - A Practice for Shiny https://shixiangwang.github.io/shinyapps/
JavaScript
5
star
30

MessageBoard

诗翔的留言板,用于博客评论和交流
HTML
5
star
31

pagedown-academic-cv-template

CSV and Markdown Driven CV, power by Pagedown
HTML
5
star
32

gcap-wes

R
5
star
33

LeetCode

LeetCode题解:使用 R/Python/Go 学习和锻炼算法能力。
R
4
star
34

sigminer-doc

Manual of Genomic Alteration Signature Analysis in R
HTML
4
star
35

ImmuneDR

A Community Curated Immune Resource Database in R format
R
4
star
36

loon

📦 A Python tookit for operating remote host based on SSH
Python
4
star
37

Rlib

Open R Function Library
R
3
star
38

gosub

GoSub: Automatically Submit PBS Files to Free Your Hands
Go
3
star
39

MarkList

Shixiang's Mark List
R
3
star
40

sigminer-book

📖 Extract, analyze and visualize mutational signatures with sigminer
TeX
3
star
41

wfun

Miscellaneous Functions by 'Shixiang Wang'
R
2
star
42

rsra

Download NCBI SRA data
R
2
star
43

ShixiangWang.github.io

https://shixiangwang.netlify.app/
HTML
2
star
44

MLnotes

Machine learning and deep learning/algorithm notes in R or Python
Jupyter Notebook
2
star
45

ezcox-adv-usage

ezcox advanced vignette
HTML
2
star
46

gcaputils

Utils for GCAP package
R
2
star
47

neopeptides

Calculate and explore property indices of peptides for cancer immunotherapy study
R
1
star
48

academictools

Materials and tools for better personal research
1
star
49

CNX

Old Repo of https://github.com/XSLiuLab/Pan-cancer_CNA_signature
R
1
star
50

neopip

neoantigen prediction pipeline
Python
1
star
51

CNVMotif

R
1
star
52

absoluteCNVdata

Pre-compiled absolute CNV data, which can be used for package sigminer/VSHunter and CNV analysis
1
star
53

picgoR

An R API to PicGo
R
1
star
54

codelife

☁️ Keep life simple now
HTML
1
star
55

cellscape

JavaScript
1
star