A variety of exogenous exposures or endogenous biological processes can contribute to the overall mutational load observed in human tumors. Many different mutational patterns, or “mutational signatures”, have been identified across different tumor types. These signatures can provide a record of environmental exposure and can give clues about the etiology of carcinogenesis. The Mutational Signature Comprehensive Analysis Toolkit (musicatk) has utilities for extracting variants from a variety of file formats, contains multiple methods for discovery of novel signatures or prediction of known signatures, as well as many types of downstream visualizations for exploratory analysis. This package has the ability to parse and combine multiple motif classes in the mutational signature discovery or prediction processes. Mutation motifs include single base substitutions (SBS), double base substitutions (DBS), insertions (INS) and deletions (DEL).
Currently musicatk can be installed from on Bioconductor using the following code:
if (!requireNamespace("BiocManager", quietly=TRUE)){
install.packages("BiocManager")}
BiocManager::install("musicatk")
To install the latest version from Github, use the following code:
if (!requireNamespace("devtools", quietly=TRUE)){
install.packages("devtools")}
library(devtools)
install_github("campbio/musicatk")
The package can be loaded using the library
command.
library(musicatk)
In order to discover or predict mutational signatures, we must first set up our musica object by 1) extracting variants from files or objects such as VCFs and MAFs, 2) selecting the appropriate reference genome 3) creating a musica object, and 4) building a count tables for our variants of interest.
Variants can be extracted from various formats using the following functions:
extract_variants_from_vcf_file()
function will extract variants from a VCF file. The file will be imported using the readVcf function from the VariantAnnotation package and then the variant information will be extracted from this object.extract_variants_from_vcf()
function extracts variants from a CollapsedVCF
or ExpandedVCF
object from the VariantAnnotation package.extract_variants_from_maf_file()
function will extract variants from a file in Mutation Annotation Format (MAF) used by TCGA.extract_variants_from_maf()
function will extract variants from a MAF object created by the maftools package.extract_variants_from_matrix()
function will get the information from a matrix or data.frame like object that has columns for the chromosome, start position, end position, reference allele, mutation allele, and sample name.extract_variants()
function will extract variants from a list of objects. These objects can be any combination of VCF files, VariantAnnotation objects, MAF files, MAF objects, and data.frame objects.Below are some examples of extracting variants from MAF and VCF files:
# Extract variants from a MAF File
lusc_maf <- system.file("extdata", "public_TCGA.LUSC.maf", package = "musicatk")
lusc.variants <- extract_variants_from_maf_file(maf_file = lusc_maf)
# Extract variants from an individual VCF file
luad_vcf <- system.file("extdata", "public_LUAD_TCGA-97-7938.vcf",
package = "musicatk")
luad.variants <- extract_variants_from_vcf_file(vcf_file = luad_vcf)
# Extract variants from multiple files and/or objects
melanoma_vcfs <- list.files(system.file("extdata", package = "musicatk"),
pattern = glob2rx("*SKCM*vcf"), full.names = TRUE)
variants <- extract_variants(c(lusc_maf, luad_vcf, melanoma_vcfs))
##
|
| | 0%
|
|============== | 20%
|
|============================ | 40%
|
|========================================== | 60%
|
|======================================================== | 80%
|
|======================================================================| 100%
musicatk uses BSgenome objects to access genome sequence information that flanks each mutation which is used bases for generating mutation count tables. BSgenome objects store full genome sequences for different organisms. A full list of supported organisms can be obtained by running available.genomes()
after loading the BSgenome library. Custom genomes can be forged as well (see BSgenome documentation). musicatk provides a utility function called select_genome()
to allow users to quickly select human genome build versions “hg19” and “hg38” or mouse genome builds “mm9” and “mm10”. The reference sequences for these genomes are in UCSC format (e.g. chr1).
g <- select_genome("hg38")
The last preprocessing step is to create an object with the variants and the genome using the create_musica
function. This function will perform checks to ensure that the chromosome names and reference alleles in the input variant object match those in supplied BSgenome object. These checks can be turned off by setting check_ref_chromosomes = FALSE
and check_ref_bases = FALSE
, respectively. This function also looks for adjacent single base substitutions (SBSs) and will convert them to double base substitutions (DBSs). To disable this automatic conversion, set convert_dbs = FALSE
.
musica <- create_musica(x = variants, genome = g)
## Checking that chromosomes in the 'variant' object match chromosomes in the 'genome' object.
## Checking that the reference bases in the 'variant' object match the reference bases in the 'genome' object.
## Warning in .check_variant_ref_in_genome(dt = dt, genome = genome): Reference
## bases for 6 out of 911 variants did not match the reference base in the
## 'genome'. Make sure the genome reference is correct.
## Standardizing INS/DEL style
## Converting 7 insertions
## Converting 1 deletions
## Converting adjacent SBS into DBS
## 5 SBS converted to DBS
Motifs are the building blocks of mutational signatures. Motifs themselves are a mutation combined with other genomic information. For instance, SBS96 motifs are constructed from an SBS mutation and one upstream and one downstream base sandwiched together. We build tables by counting these motifs for each sample.
build_standard_table(musica, g = g, table_name = "SBS96")
## Building count table from SBS with SBS96 schema
Here is a list of mutation tables that can be created by setting the
table_name
parameter in the build_standard_table
function:
"Transcript_Strand"
."Replication_Strand"
.data(dbs_musica)
build_standard_table(dbs_musica, g, "SBS96", overwrite = TRUE)
## Building count table from SBS with SBS96 schema
## Warning in .table_exists_warning(musica, "SBS96", overwrite): Overwriting
## counts table: SBS96
build_standard_table(dbs_musica, g, "DBS78", overwrite = TRUE)
## Building count table from DBS with DBS78 schema
## Warning in .table_exists_warning(musica, "DBS78", overwrite): Overwriting
## counts table: DBS78
#Subset SBS table to DBS samples so they cam be combined
count_tables <- tables(dbs_musica)
overlap_samples <- which(colnames(count_tables$SBS96@count_table) %in%
colnames(count_tables$DBS78@count_table))
count_tables$SBS96@count_table <- count_tables$SBS96@count_table[, overlap_samples]
tables(dbs_musica) <- count_tables
combine_count_tables(musica = dbs_musica, to_comb = c("SBS96", "DBS78"),
name = "sbs_dbs", description = "An example combined
table, combining SBS96 and DBS", overwrite = TRUE)
annotate_transcript_strand(musica, "19", build_table = FALSE)
## 403 genes were dropped because they have exons located on both strands
## of the same reference sequence or on more than one reference sequence,
## so cannot be represented by a single genomic range.
## Use 'single.strand.genes.only=FALSE' to get all the genes in a
## GRangesList object, or use suppressMessages() to suppress this message.
build_custom_table(musica = musica, variant_annotation = "Transcript_Strand",
name = "Transcript_Strand",
description = "A table of transcript strand of variants",
data_factor = c("T", "U"), overwrite = TRUE)
Different count tables can be combined into one using the combine_count_tables
function. For example, the SBS96 and the DBS tables could be combined and
mutational signature discovery could be performed across both mutations
modalities. Tables with information about the same types of variants (e.g.
two related SBS tables) should generally not be combined and used together.
Custom count tables can be created from user-defined mutation-level annotations
using the build_custom_table
function.
Mutational signature discovery is the process of deconvoluting a matrix
containing counts for each mutation type in each sample into two matrices: 1)
a signature matrix containing the probability of each mutation motif in
signature and 2) an exposure matrix containing the estimated counts of each
signature in each sample. Discovery and prediction results are save in a
musica_result
object that includes both the signatures and sample exposures.
result <- discover_signatures(musica = musica, table_name = "SBS96",
num_signatures = 3, algorithm = "nmf",
nstart = 10)
Supported signature discovery algorithms include:
Both have built-in seed
capabilities for reproducible results, nstarts
for
multiple independent chains from which the best final result will be chosen.
NMF also allows for parallel processing via par_cores
.
To get the signatures or exposures from the result object, the following functions can be used:
# Extract the exposure matrix
expos <- exposures(result)
expos[1:3,1:3]
## TCGA-56-7582-01A-11D-2042-08 TCGA-77-7335-01A-11D-2042-08
## Signature1 9.910392e+00 2.963251e-09
## Signature2 2.860983e-07 1.610374e+02
## Signature3 1.800896e+02 1.069626e+02
## TCGA-94-7557-01A-11D-2122-08
## Signature1 1.030442e+00
## Signature2 1.159696e+02
## Signature3 2.886599e-13
# Extract the signature matrix
sigs <- signatures(result)
sigs[1:3,1:3]
## Signature1 Signature2 Signature3
## C>A_ACA 7.561675e-11 0.013628647 1.254321e-02
## C>A_ACC 7.684567e-11 0.007898625 1.641794e-02
## C>A_ACG 8.596657e-11 0.010725916 8.347563e-11
Barplots showing the probability of each mutation type in each signature can
be plotted with the plot_signatures
function:
plot_signatures(result)
By default, the scales on the y-axis are forced to be the same across all
signatures. This behavior can be turned off by setting same_scale = FALSE
.
Signatures can be re-named based on prior knowledge and displayed in the plots:
name_signatures(result, c("Smoking", "APOBEC", "UV"))
plot_signatures(result)
Barplots showing the exposures in each sample can be plotted with the
plot_exposures
function:
plot_exposures(result, plot_type = "bar")
The proportion of each exposure in each tumor can be shown by setting proportional = TRUE
:
plot_exposures(result, plot_type = "bar", proportional = TRUE)
Counts for individual samples can also be plotted with the plot_sample_counts
function:
samples <- sample_names(musica)
plot_sample_counts(musica, sample_names = samples[c(3,4,5)], table_name = "SBS96")
A common analysis is to compare the signatures estimated in a dataset to those generated in other datasets or to those in the COSMIC database. We have a set of functions that can be used to easily perform pairwise correlations between signatures. The compare_results
functions compares the signatures between two musica_result
objects. The compare_cosmic_v2
will correlate the signatures between a musica_result
object and the SBS signatures in COSMIC V2. For example:
compare_cosmic_v2(result, threshold = 0.75)
## cosine x_sig_index y_sig_index x_sig_name y_sig_name
## 1 0.9733111 1 7 Smoking Signature7
## 4 0.7906308 3 4 UV Signature4
## 2 0.7720306 1 11 Smoking Signature11
## 3 0.7547538 1 30 Smoking Signature30
In this example, our Signatures 1 and 2 were most highly correlated to COSMIC Signature 7 and 4, respectively, so this may indicate that samples in our dataset were exposed to UV radiation or cigarette smoke. Only pairs of signatures who have a correlation above the threshold
parameter will be returned. If no pairs of signatures are found, then you may want to consider lowering the threshold. The default correlation metric is the cosine similarity, but this can be changed to using 1 - Jensen-Shannon Divergence by setting
metric = "jsd"
Signatures can also be correlated to those in the COSMIC V3 database using the compare_cosmic_v3
function.
Instead of discovering mutational signatures and exposures from a dataset de novo, one might get better results by predicting the exposures of signatures that have been previously estimated in other datasets. We incorporate several methods for estimating exposures given a set of pre-existing signatures. For example, we can predict exposures for COSMIC signatures 1, 4, 7, and 13 in our current dataset:
# Load COSMIC V2 data
data("cosmic_v2_sigs")
# Predict pre-existing exposures using the "lda" method
pred_cosmic <- predict_exposure(musica = musica, table_name = "SBS96",
signature_res = cosmic_v2_sigs,
signatures_to_use = c(1, 4, 7, 13),
algorithm = "lda")
# Plot exposures
plot_exposures(pred_cosmic, plot_type = "bar")
The cosmic_v2_sigs
object is just a musica_result
object containing COSMIC V2 signatures without any sample or exposure information. Note that if signatures_to_use
is not supplied by the user, then exposures for all signatures in the result object will be estimated. We can predict exposures for samples in any musica
object from any musica_result
object as long as the same mutation schema was utilized.
We can list which signatures are present in each tumor type according to the COSMIC V2 database. For example, we can find which signatures are present in lung cancers:
cosmic_v2_subtype_map("lung")
## lung adeno
## 124561317
## lung small cell
## 14515
## lung squamous
## 124513
We can predict exposures for samples in a musica
object using the signatures from any musica_result
object. Just for illustration, we will predict exposures using the estimated signatures from musica_result
object we created earlier:
pred_our_sigs <- predict_exposure(musica = musica, table_name = "SBS96",
signature_res = result, algorithm = "lda")
Of course, this example is not very useful because we are predicting exposures using signatures that were learned on the same set of samples. Most of the time, you want to give the signature_res
parameter a musica_result
object that wss generated using independent samples from those in the musica
object. As mentioned above, different signatures in different result objects can be compared to each other using the compare_results
function:
compare_results(result = pred_cosmic, other_result = pred_our_sigs,
threshold = 0.60)
## cosine x_sig_index y_sig_index x_sig_name y_sig_name
## 2 0.9733111 3 1 Signature7 Smoking
## 1 0.7906308 2 3 Signature4 UV
## 3 0.7412271 4 2 Signature13 APOBEC
We first must add an annotation to the musica
or musica_result
object
annot <- read.table(system.file("extdata", "sample_annotations.txt",
package = "musicatk"), sep = "\t", header=TRUE)
samp_annot(result, "Tumor_Subtypes") <- annot$Tumor_Subtypes
Note that the annotations can also be added directly the musica
object in the beginning using the same function: samp_annot(musica, "Tumor_Subtypes") <- annot$Tumor_Subtypes
. These annotations will then automatically be included in any down-stream result object.
musica
or musica_result
object. You can view the sample order with the sample_names
function:sample_names(result)
## [1] TCGA-56-7582-01A-11D-2042-08 TCGA-77-7335-01A-11D-2042-08
## [3] TCGA-94-7557-01A-11D-2122-08 TCGA-97-7938-01A-11D-2167-08
## [5] TCGA-EE-A3J5-06A-11D-A20D-08 TCGA-ER-A197-06A-32D-A197-08
## [7] TCGA-ER-A19O-06A-11D-A197-08
## 7 Levels: TCGA-56-7582-01A-11D-2042-08 ... TCGA-ER-A19O-06A-11D-A197-08
As mentioned previously, the plot_exposures
function can plot sample exposures in a musica_result
object. It can group exposures by either a sample annotation or by a signature by setting the group_by
parameter. Here will will group the exposures by the Tumor_Subtype
annotation:
plot_exposures(result, plot_type = "bar", group_by = "annotation",
annotation = "Tumor_Subtypes")
The distribution of exposures with respect to annotation can be viewed using boxplots by setting plot_type = "box"
and group_by = "annotation"
:
plot_exposures(result, plot_type = "box", group_by = "annotation", annotation = "Tumor_Subtypes")
Note that the name of the annotation must be supplied via the annotation
parameter. Boxplots can be converted to violin plots by setting plot_type = "violin"
. To compare the level of each exposure across sample groups within a signature, we can set group_by = "signature"
and color_by = "annotation"
:
plot_exposures(result, plot_type = "box", group_by = "signature",
color_by = "annotation", annotation = "Tumor_Subtypes")
The create_umap
function embeds samples in 2 dimensions using the umap
function from the uwot package. The major parameters for fine tuning the UMAP are n_neighbors
, min_dist
, and spread
. See ?uwot::umap
for more information on these parameters.
create_umap(result = result)
## The parameter 'n_neighbors' cannot be bigger than the total number of samples. Setting 'n_neighbors' to 7.
The plot_umap
function will generate a scatter plot of the UMAP coordinates. The points of plot will be colored by the level of a signature by default:
plot_umap(result = result)
By default, the exposures for each sample will share the same color scale. However, exposures for some signatures may have really high levels compared to others. To make a plot where exposures for each signature will have their own color scale, you can set same_scale = FALSE
:
plot_umap(result = result, same_scale = FALSE)
Lastly, points can be colored by a Sample Annotation by setting color_by = "annotation"
and annotation
to the name of the annotation:
plot_umap(result = result, color_by = "annotation",
annotation = "Tumor_Subtypes", add_annotation_labels = TRUE)
When add_annotation_labels = TRUE
, the centroid of each group is identified
using medians and the labels are plotted on top of the centroid.
plot_signatures, plot_exposures, and plot_umap, all have builty in ggplotly
capabilities. Simply specifying plotly = TRUE
enables interactive plots
that allows examination of individuals sections, zooming and resizing, and
turning on and off annotation types and legend values.
plot_signatures(result, plotly = TRUE)
plot_exposures(result, plotly = TRUE)
plot_umap(result, plotly = TRUE)
Several functions make use of stochastic algorithms or procedures which
require the use of random number generator (RNG) for simulation or sampling.
To maintain reproducibility, all these functions should be called using
set_seed(1)
or withr::with_seed(seed, function())
to make sure
same results are generatedeach time one of these functions is called. Using
with_seed for reproducibility has the advantage of not interfering with any
other user seeds, but using one or the other is important for several functions
including discover_signatures, predict_exposure, and create_umap, as
these functions use stochastic processes that may produce different results
when run multiple times with the same settings.
seed <- 1
reproducible_prediction <- withr::with_seed(seed,
predict_exposure(musica = musica,
table_name = "SBS96",
signature_res = result, algorithm = "lda"))
sessionInfo()
## R version 4.3.1 (2023-06-16)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 22.04.3 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.18-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.10.0
##
## locale:
## [1] LC_CTYPE=en_US.UTF-8 LC_NUMERIC=C
## [3] LC_TIME=en_GB LC_COLLATE=C
## [5] LC_MONETARY=en_US.UTF-8 LC_MESSAGES=en_US.UTF-8
## [7] LC_PAPER=en_US.UTF-8 LC_NAME=C
## [9] LC_ADDRESS=C LC_TELEPHONE=C
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C
##
## time zone: America/New_York
## tzcode source: system (glibc)
##
## attached base packages:
## [1] parallel stats graphics grDevices utils datasets methods
## [8] base
##
## other attached packages:
## [1] doParallel_1.0.17 iterators_1.0.14 foreach_1.5.2
## [4] XVector_0.42.0 GenomicRanges_1.54.0 IRanges_2.36.0
## [7] S4Vectors_0.40.0 musicatk_1.12.0 NMF_0.26
## [10] bigmemory_4.6.1 Biobase_2.62.0 BiocGenerics_0.48.0
## [13] cluster_2.1.4 rngtools_1.5.2 registry_0.5-1
## [16] BiocStyle_2.30.0
##
## loaded via a namespace (and not attached):
## [1] RColorBrewer_1.1-3
## [2] jsonlite_1.8.7
## [3] shape_1.4.6
## [4] magrittr_2.0.3
## [5] magick_2.8.1
## [6] GenomicFeatures_1.54.0
## [7] farver_2.1.1
## [8] rmarkdown_2.25
## [9] GlobalOptions_0.1.2
## [10] BiocIO_1.12.0
## [11] zlibbioc_1.48.0
## [12] vctrs_0.6.4
## [13] memoise_2.0.1
## [14] matrixTests_0.2.3
## [15] Rsamtools_2.18.0
## [16] RCurl_1.98-1.12
## [17] rstatix_0.7.2
## [18] htmltools_0.5.6.1
## [19] S4Arrays_1.2.0
## [20] TxDb.Hsapiens.UCSC.hg19.knownGene_3.2.2
## [21] progress_1.2.2
## [22] curl_5.1.0
## [23] broom_1.0.5
## [24] SparseArray_1.2.0
## [25] sass_0.4.7
## [26] bslib_0.5.1
## [27] htmlwidgets_1.6.2
## [28] plyr_1.8.9
## [29] plotly_4.10.3
## [30] cachem_1.0.8
## [31] uuid_1.1-1
## [32] GenomicAlignments_1.38.0
## [33] lifecycle_1.0.3
## [34] pkgconfig_2.0.3
## [35] Matrix_1.6-1.1
## [36] R6_2.5.1
## [37] fastmap_1.1.1
## [38] GenomeInfoDbData_1.2.11
## [39] MatrixGenerics_1.14.0
## [40] clue_0.3-65
## [41] digest_0.6.33
## [42] colorspace_2.1-0
## [43] AnnotationDbi_1.64.0
## [44] maftools_2.18.0
## [45] irlba_2.3.5.1
## [46] crosstalk_1.2.0
## [47] RSQLite_2.3.1
## [48] ggpubr_0.6.0
## [49] labeling_0.4.3
## [50] filelock_1.0.2
## [51] fansi_1.0.5
## [52] httr_1.4.7
## [53] abind_1.4-5
## [54] compiler_4.3.1
## [55] withr_2.5.1
## [56] bit64_4.0.5
## [57] backports_1.4.1
## [58] BiocParallel_1.36.0
## [59] carData_3.0-5
## [60] DBI_1.1.3
## [61] ggsignif_0.6.4
## [62] biomaRt_2.58.0
## [63] MASS_7.3-60
## [64] rappdirs_0.3.3
## [65] DelayedArray_0.28.0
## [66] rjson_0.2.21
## [67] gtools_3.9.4
## [68] DNAcopy_1.76.0
## [69] tools_4.3.1
## [70] MCMCprecision_0.4.0
## [71] glue_1.6.2
## [72] restfulr_0.0.15
## [73] grid_4.3.1
## [74] gridBase_0.4-7
## [75] reshape2_1.4.4
## [76] generics_0.1.3
## [77] gtable_0.3.4
## [78] BSgenome_1.70.0
## [79] tidyr_1.3.0
## [80] data.table_1.14.8
## [81] hms_1.1.3
## [82] car_3.1-2
## [83] xml2_1.3.5
## [84] utf8_1.2.4
## [85] RcppAnnoy_0.0.21
## [86] ggrepel_0.9.4
## [87] pillar_1.9.0
## [88] stringr_1.5.0
## [89] circlize_0.4.15
## [90] splines_4.3.1
## [91] dplyr_1.1.3
## [92] BiocFileCache_2.10.0
## [93] lattice_0.22-5
## [94] survival_3.5-7
## [95] rtracklayer_1.62.0
## [96] bit_4.0.5
## [97] tidyselect_1.2.0
## [98] BSgenome.Hsapiens.UCSC.hg38_1.4.5
## [99] ComplexHeatmap_2.18.0
## [100] Biostrings_2.70.0
## [101] knitr_1.44
## [102] gridExtra_2.3
## [103] bigmemory.sri_0.1.6
## [104] bookdown_0.36
## [105] SummarizedExperiment_1.32.0
## [106] stats4_4.3.1
## [107] xfun_0.40
## [108] matrixStats_1.0.0
## [109] stringi_1.7.12
## [110] lazyeval_0.2.2
## [111] yaml_2.3.7
## [112] TxDb.Hsapiens.UCSC.hg38.knownGene_3.18.0
## [113] evaluate_0.22
## [114] codetools_0.2-19
## [115] tibble_3.2.1
## [116] BiocManager_1.30.22
## [117] cli_3.6.1
## [118] uwot_0.1.16
## [119] munsell_0.5.0
## [120] jquerylib_0.1.4
## [121] Rcpp_1.0.11
## [122] GenomeInfoDb_1.38.0
## [123] dbplyr_2.3.4
## [124] tidyverse_2.0.0
## [125] png_0.1-8
## [126] XML_3.99-0.14
## [127] ellipsis_0.3.2
## [128] ggplot2_3.4.4
## [129] blob_1.2.4
## [130] prettyunits_1.2.0
## [131] bitops_1.0-7
## [132] viridisLite_0.4.2
## [133] VariantAnnotation_1.48.0
## [134] scales_1.2.1
## [135] combinat_0.0-8
## [136] purrr_1.0.2
## [137] crayon_1.5.2
## [138] GetoptLong_1.0.5
## [139] rlang_1.1.1
## [140] cowplot_1.1.1
## [141] KEGGREST_1.42.0