-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathREADME.Rmd
244 lines (177 loc) · 12.2 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
warning = FALSE
)
```
# Sigminer: Mutational Signature Analysis and Visualization in R <img src="man/figures/logo.png" alt="logo" align="right" height="140" width="120"/>
[](https://cran.r-project.org/package=sigminer) [](https://lifecycle.r-lib.org/articles/stages.html) [](https://github.com/ShixiangWang/sigminer/actions) [](https://cran.r-project.org/package=sigminer) [](https://github.com/ShixiangWang/sigminer/issues?q=is%3Aissue+is%3Aclosed) [](https://hits.seeyoufarm.com)  [](https://biotreasury.rjmart.cn/#/tool?id=10043)
## :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](https://github.com/ShixiangWang/sigflow).
**SBS signatures**:
```{r, fig.width=12, fig.height=5, echo=FALSE, message=FALSE}
library(sigminer)
load(system.file("extdata", "toy_mutational_signature.RData",
package = "sigminer", mustWork = TRUE
))
# Show signature profile
p1 <- show_sig_profile(sig2, mode = "SBS", style = "cosmic", x_label_angle = 90)
p1
```
**Copy number signatures**:
```{r fig.width=12, fig.height=5, echo=FALSE}
load(system.file("extdata", "toy_copynumber_signature_by_W.RData",
package = "sigminer", mustWork = TRUE
))
# Show signature profile
p2 <- show_sig_profile(sig,
style = "cosmic",
mode = "copynumber",
method = "W",
normalize = "feature"
)
p2
```
```{r fig.width=12, fig.height=5, echo=FALSE}
show_sig_profile(get_sig_db("CNS_TCGA")$db[, 1:3], style = "cosmic",
mode = "copynumber", method = "S", check_sig_names = FALSE)
```
**DBS signatures**:
```{r fig.width=12, fig.height=5, echo=FALSE}
DBS = system.file("extdata", "DBS_signatures.rds",
package = "sigminer", mustWork = TRUE)
DBS = readRDS(DBS)
# Show signature profile
p3 <- show_sig_profile(DBS$db[, 1:3] %>% as.matrix(), mode = "DBS", style = "cosmic", check_sig_names = FALSE)
p3
```
**INDEL (i.e. ID) signatures**:
```{r fig.width=12, fig.height=5, echo=FALSE}
ID = system.file("extdata", "ID_signatures.rds",
package = "sigminer", mustWork = TRUE)
ID = readRDS(ID)
# Show signature profile
p4 <- show_sig_profile(ID$db[, 4:6] %>% as.matrix(), mode = "ID", style = "cosmic", check_sig_names = FALSE)
p4
```
**Genome rearrangement signatures**:
```{r fig.width=10, fig.height=5, echo=FALSE, message=FALSE}
p5 <- show_cosmic_sig_profile(sig_index = c("R1", "R2", "R3"), sig_db = "RS_Nik_lab", style = "cosmic", show_index = FALSE)
p5
```
### :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:
```{r, eval=FALSE}
install.packages("BiocManager")
BiocManager::install("sigminer", dependencies = TRUE)
```
You can install the development version of **sigminer** from Github with:
```{r, eval=FALSE}
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
```sh
# 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.
## :question: QA
### How to install the `copynumber` package
For some extra features provided by **sigminer**, **copynumber** package is required. Due to the removal of the **copynumber** package from Bioc, I had to remove it from the dependencies in v2.2.0. You can install the package from <https://github.com/shixiangwang/copynumber/>. It is generally recommended as I have added some features, although other forks of this package exist on GitHub.
```r
remotes::install_github("ShixiangWang/copynumber")
```
## :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
```{r, echo=FALSE, warning=FALSE, message=FALSE, dpi=300}
library("ggplot2")
library("cranlogs")
library("dplyr")
library("spiralize")
library("ComplexHeatmap")
library("lubridate")
df <- cran_downloads("sigminer", from = "2019-07-01", to = "2024-06-07")
if (!is.null(df)) {
day_diff = as.double(df$date[nrow(df)] - df$date[1], "days")
year_mean = tapply(df$count, lubridate::year(df$date), function(x) mean(x[x > 0]))
df$diff = log2(df$count/year_mean[as.character(lubridate::year(df$date))])
df$diff[is.infinite(df$diff)] = 0
q = quantile(abs(df$diff), 0.99) # adjust outliers
df$diff[df$diff > q] = q
df$diff[df$diff < -q] = -q
spiral_initialize_by_time(xlim = range(df[, 1]), padding = unit(2, "cm"), verbose = FALSE)
spiral_track(height = 0.8)
spiral_horizon(df$date, df$diff, use_bars = TRUE)
spiral_highlight("start", "2019-12-31", type = "line", gp = gpar(col = 1))
spiral_highlight("2020-01-01", "2020-12-31", type = "line", gp = gpar(col = 2))
spiral_highlight("2021-01-01", "2021-12-31", type = "line", gp = gpar(col = 3))
spiral_highlight("2022-01-01", "2022-12-31", type = "line", gp = gpar(col = 4))
spiral_highlight("2023-01-01", "2023-12-31", type = "line", gp = gpar(col = 5))
spiral_highlight("2024-01-01", "end", type = "line", gp = gpar(col = 6))
s = current_spiral()
d = seq(15, 360, by = 30) %% 360
for(i in seq_along(d)) {
foo = polar_to_cartesian(d[i]/180*pi, (s$max_radius + 1)*1.05)
grid.text(month.name[i], x = foo[1, 1], y = foo[1, 2], default.unit = "native",
rot = ifelse(d[i] > 0 & d[i] < 180, d[i] - 90, d[i] + 90), gp = gpar(fontsize = 10))
}
lgd = packLegend(
Legend(title = "Difference to\nyearly average", at = c("higher", "lower"),
legend_gp = gpar(fill = c("#D73027", "#313695"))),
Legend(title = "Year", type = "lines", at = 2019:2024,
legend_gp = gpar(col = 1:5))
)
draw(lgd, x = unit(1, "npc") + unit(10, "mm"), just = "left")
}
```
## :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](https://github.com/ShixiangWang/sigminer/blob/master/LICENSE.md). 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**](https://github.com/XSLiuLab) **\@ShanghaiTech**
