# Using supersigs

    library(supersigs)

# Introduction

The `supersigs` package implements the supervised method proposed by Afsari, et al. to find signatures (“SuperSigs”). In this vignette, we cover how to preprocess your data and run the method in `supersigs`.

# Preprocessing your data

## VCF file

If you have a VCF file, you can use `readVcf` from the `VariantAnnotation` package to read in your VCF file as a VCF object. The age of each patient should be stored as `age` in the `colData` of your `VCF` object. Then use `process_vcf` to transform the VCF object into a simplified data frame format, which will be explained further in Example data.

If you do not have a VCF file, skip to Example data.

    # Load packages for make_matrix function
    suppressPackageStartupMessages({
      library(VariantAnnotation)
    })

    fl <- system.file("extdata", "chr22.vcf.gz", package="VariantAnnotation")
    vcf <- VariantAnnotation::readVcf(fl, "hg19")
    # Subset to first sample
    vcf <- vcf[, 1]
    # Subset to row positions with homozygous or heterozygous alt
    positions <- geno(vcf)$GT != "0|0"
    vcf <- vcf[positions[, 1],]
    colData(vcf)$age <- 50    # Add patient age to colData
    dt <- process_vcf(vcf)
    head(dt)
    #>   sample_id age chromosome position ref alt
    #> 1   HG00096  50      chr22 50326116   C   T
    #> 2   HG00096  50      chr22 50336761   G   A
    #> 3   HG00096  50      chr22 50346072   C   T
    #> 4   HG00096  50      chr22 50350418   T   C
    #> 5   HG00096  50      chr22 50351413   C   T
    #> 6   HG00096  50      chr22 50351977   G   A

## Example data

The method uses single-base mutations in exomic data from cancer samples. Specifically, it requires data on every sample’s mutations, the positions of those mutations, and the age of all patients. This data can be represented as a list of mutations. Below is an example dataset (stored and accessible from the `supersigs` R package). If you have a VCF file, read the VCF file section to see how to process your data into the following format.

- `sample_id` is an ID for each sample
- `age` is the age of the patient
- `chromosome` and `position` is the position of the mutation
- `ref` is the original nucleotide
- `alt` is the mutated nucleotide

    head(example_dt)
    #>   sample_id age chromosome  position ref alt
    #> 1         1  50       chr1  94447621   G   C
    #> 2         1  50       chr2 202005395   A   C
    #> 3         1  50       chr7  20784978   T   A
    #> 4         1  50       chr7  87179255   C   G
    #> 5         1  50      chr19   1059712   G   T
    #> 6         2  55       chr1  76226977   T   C

## Transform data

Once you’ve read in your data, you will need to transform it into a data frame of features before running the core functions. This involves 2 steps:

1. First, we assume that mutations are the same regardless of the strand on which it occurred. For example, this means that C>A mutations are considered the same as G>T mutations and we will convert all G>T mutations to be denoted as C>A mutations.

2. Because the features used are built upon trinucleotide features (e.g. A[C>A]T), this will require matching your mutations to a reference genome to identify what the flanking bases of every mutation are. In our example below, we will use the `hg19` reference genome.

Both of these steps are done by the `make_matrix` function. Note that using the `make_matrix` function requires installing and loading a reference genome (`BSgenome.Hsapiens.UCSC.hg19` and `BSgenome.Hsapiens.UCSC.hg38` are supported).

    # Load packages for make_matrix function
    suppressPackageStartupMessages({
      library(BSgenome.Hsapiens.UCSC.hg19)
    })

We apply `make_matrix` to transform our example dataset (`example_dt`) into a data frame of trinucleotide mutations (`input_dt`), which is the format required by the `supersigs` R package. Each row in `input_dt` corresponds to a different patient and the values in the columns are the number of mutations for each trinucleotide mutation.

    input_dt <- make_matrix(example_dt)
    head(input_dt)
    #> # A tibble: 5 × 98
    #>   sample_id   age `A[T>G]T` `C[T>A]A` `G[C>A]A` `G[C>G]G` `G[C>G]T` `A[C>G]T`
    #>       <dbl> <dbl>     <dbl>     <dbl>     <dbl>     <dbl>     <dbl>     <dbl>
    #> 1         1    50         1         1         1         1         1         0
    #> 2         2    55         0         0         0         0         0         1
    #> 3         3    72         1         1         0         0         0         0
    #> 4         4    53         0         0         0         0         0         1
    #> 5         5    48         0         1         1         0         0         0
    #> # ℹ 90 more variables: `C[C>A]T` <dbl>, `C[T>C]G` <dbl>, `T[C>A]C` <dbl>,
    #> #   `T[C>A]T` <dbl>, `A[T>C]C` <dbl>, `C[T>C]C` <dbl>, `T[T>A]C` <dbl>,
    #> #   `C[C>G]G` <dbl>, `G[C>T]A` <dbl>, `A[C>A]T` <dbl>, `C[C>A]C` <dbl>,
    #> #   `G[T>G]T` <dbl>, `C[C>T]C` <dbl>, `T[C>T]C` <dbl>, `A[C>T]C` <dbl>,
    #> #   `G[C>T]C` <dbl>, `C[C>T]T` <dbl>, `T[C>T]T` <dbl>, `A[C>T]T` <dbl>,
    #> #   `G[C>T]T` <dbl>, `C[C>T]A` <dbl>, `T[C>T]A` <dbl>, `A[C>T]A` <dbl>,
    #> #   `C[C>T]G` <dbl>, `T[C>T]G` <dbl>, `A[C>T]G` <dbl>, `G[C>T]G` <dbl>, …

# Getting your signature

To apply the supervised method on your data, run the `get_signature` function. The function has two parameters: an input data frame `data` and the `factor` (e.g. `factor = "Smoking"`). `data` is a data frame with the following columns:

- `IndVar` (indicator variable) is a logical indicator for whether they were exposed to the `factor` or not
- `sample_id` is an ID for each sample
- `age` is the age of the patient
- columns of counts for all 96 trinucleotide mutations

The process of converting a VCF file to this format is covered in Preprocessing your data. An example for `data` is printed below.

    suppressPackageStartupMessages({
      library(dplyr)
    })

    # Add IndVar column
    input_dt <- input_dt %>%
      mutate(IndVar = c(1, 1, 1, 0, 0)) %>%
      relocate(IndVar)

    head(input_dt)
    #> # A tibble: 5 × 99
    #>   IndVar sample_id   age `A[T>G]T` `C[T>A]A` `G[C>A]A` `G[C>G]G` `G[C>G]T`
    #>    <dbl>     <dbl> <dbl>     <dbl>     <dbl>     <dbl>     <dbl>     <dbl>
    #> 1      1         1    50         1         1         1         1         1
    #> 2      1         2    55         0         0         0         0         0
    #> 3      1         3    72         1         1         0         0         0
    #> 4      0         4    53         0         0         0         0         0
    #> 5      0         5    48         0         1         1         0         0
    #> # ℹ 91 more variables: `A[C>G]T` <dbl>, `C[C>A]T` <dbl>, `C[T>C]G` <dbl>,
    #> #   `T[C>A]C` <dbl>, `T[C>A]T` <dbl>, `A[T>C]C` <dbl>, `C[T>C]C` <dbl>,
    #> #   `T[T>A]C` <dbl>, `C[C>G]G` <dbl>, `G[C>T]A` <dbl>, `A[C>A]T` <dbl>,
    #> #   `C[C>A]C` <dbl>, `G[T>G]T` <dbl>, `C[C>T]C` <dbl>, `T[C>T]C` <dbl>,
    #> #   `A[C>T]C` <dbl>, `G[C>T]C` <dbl>, `C[C>T]T` <dbl>, `T[C>T]T` <dbl>,
    #> #   `A[C>T]T` <dbl>, `G[C>T]T` <dbl>, `C[C>T]A` <dbl>, `T[C>T]A` <dbl>,
    #> #   `A[C>T]A` <dbl>, `C[C>T]G` <dbl>, `T[C>T]G` <dbl>, `A[C>T]G` <dbl>, …

Once you have the correct data format, apply `get_signature` to the dataset to get your `SuperSig`, which is an S4 object containing four slots:

- `Signature` is the signature, represented as their differences in mean rates (or the overall mean rate if the factor is “age”) between the two groups (exposed versus unexposed)
- `Features` is the list of features that comprise the signature and their representation in terms of the fundamental (trinucleotide) mutations
- `AUC` is the apparent AUC of the model (i.e. not cross-validated)
- `Model` is the list containing the trained logistic regression model (glm class)

    set.seed(1)
    supersig <- get_signature(data = input_dt, factor = "Smoking")
    #> Begin feature engineering...
    #> Begin cross-validated selection over 4 features and 15 inner folds...
    #> ...testing inner fold 1
    #> ...testing inner fold 2
    #> ...testing inner fold 3
    #> ...testing inner fold 4
    #> ...testing inner fold 5
    #> ...testing inner fold 6
    #> ...testing inner fold 7
    #> ...testing inner fold 8
    #> ...testing inner fold 9
    #> ...testing inner fold 10
    #> ...testing inner fold 11
    #> ...testing inner fold 12
    #> ...testing inner fold 13
    #> ...testing inner fold 14
    #> ...testing inner fold 15
    supersig
    #> Signature:
    #>              X1
    #> 1 -0.0007475199
    #> Features:
    #> $X1
    #>       F11       F12       F13       F14      F117      F118      F119      F120
    #> "A[C>A]A" "A[C>A]C" "A[C>A]G" "A[C>A]T" "A[C>G]A" "A[C>G]C" "A[C>G]G" "A[C>G]T"
    #>      F132      F133      F134      F135      F148      F149      F150      F151
    #> "A[C>T]A" "A[C>T]C" "A[C>T]G" "A[C>T]T" "A[T>A]A" "A[T>A]C" "A[T>A]G" "A[T>A]T"
    #>      F163      F164      F165      F166      F179      F180      F181       F15
    #> "A[T>C]A" "A[T>C]C" "A[T>C]G" "A[T>C]T" "A[T>G]A" "A[T>G]C" "A[T>G]G" "C[C>A]A"
    #>       F16       F17       F18      F121      F122      F123      F124      F136
    #> "C[C>A]C" "C[C>A]G" "C[C>A]T" "C[C>G]A" "C[C>G]C" "C[C>G]G" "C[C>G]T" "C[C>T]A"
    #>      F137      F138      F139      F152      F153      F154      F167      F168
    #> "C[C>T]C" "C[C>T]G" "C[C>T]T" "C[T>A]C" "C[T>A]G" "C[T>A]T" "C[T>C]A" "C[T>C]C"
    #>      F169      F170      F182      F183      F184      F185       F19      F110
    #> "C[T>C]G" "C[T>C]T" "C[T>G]A" "C[T>G]C" "C[T>G]G" "C[T>G]T" "G[C>A]A" "G[C>A]C"
    #>      F111      F112      F125      F126      F127      F140      F141      F142
    #> "G[C>A]G" "G[C>A]T" "G[C>G]A" "G[C>G]C" "G[C>G]T" "G[C>T]A" "G[C>T]C" "G[C>T]G"
    #>      F143      F155      F156      F157      F158      F171      F172      F173
    #> "G[C>T]T" "G[T>A]A" "G[T>A]C" "G[T>A]G" "G[T>A]T" "G[T>C]A" "G[T>C]C" "G[T>C]G"
    #>      F174      F186      F187      F188      F189      F113      F114      F115
    #> "G[T>C]T" "G[T>G]A" "G[T>G]C" "G[T>G]G" "G[T>G]T" "T[C>A]A" "T[C>A]C" "T[C>A]G"
    #>      F116      F128      F129      F130      F131      F144      F145      F146
    #> "T[C>A]T" "T[C>G]A" "T[C>G]C" "T[C>G]G" "T[C>G]T" "T[C>T]A" "T[C>T]C" "T[C>T]G"
    #>      F147      F159      F160      F161      F162      F175      F176      F177
    #> "T[C>T]T" "T[T>A]A" "T[T>A]C" "T[T>A]G" "T[T>A]T" "T[T>C]A" "T[T>C]C" "T[T>C]G"
    #>      F178      F190      F191      F192      F193
    #> "T[T>C]T" "T[T>G]A" "T[T>G]C" "T[T>G]G" "T[T>G]T"
    #>
    #> Model:
    #> $Logit
    #>
    #> Call:  glm(formula = IndVar ~ ., family = binomial(), data = x)
    #>
    #> Coefficients:
    #> (Intercept)           X1
    #>       7.118      -86.601
    #>
    #> Degrees of Freedom: 4 Total (i.e. Null);  3 Residual
    #> Null Deviance:       6.73
    #> Residual Deviance: 4.279     AIC: 8.279

To obtain a signature representation that is more interpretable, you can group the trinucleotide features within each feature using the `simplify_signature` function (with an option to use IUPAC labels). This is useful for making plots of signatures.

    features <- simplify_signature(object = supersig, iupac = FALSE)
    features_iupac <- simplify_signature(object = supersig, iupac = TRUE)

    library(ggplot2)
    data.frame(features = names(features_iupac),
               differences = features_iupac) %>%
      ggplot(aes(x = features, y = differences)) +
      geom_col() +
      theme_minimal()

# Using a signature

To apply the `SuperSig` to a new dataset, use the `predict_signature` function. This function returns the new dataset with columns for feature counts for the signature and a score column for the predicted classification score.

Below is an example for the `SuperSig` we trained in the previous section. We reuse `input_dt` as our “new data” for illustrative purposes, but in practice, you would use a different dataset from the one that was used to train the signature (e.g. a test set).

    newdata = predict_signature(supersig, newdata = input_dt, factor = "Smoking")

    newdata %>%
      select(X1, score)
    #> # A tibble: 5 × 2
    #>       X1 score
    #>    <dbl> <dbl>
    #> 1 0.04   0.975
    #> 2 0.0909 0.320
    #> 3 0.0417 0.971
    #> 4 0.0943 0.259
    #> 5 0.0833 0.475

In addition, you may wish to use a `SuperSig` pre-trained on TCGA data. These are accessible from the package in `supersig_ls`, where each element of the list is a `SuperSig`. There are 67 SuperSigs that have been trained on various tissues and factors. The names are printed below (formatted as “factor (tissue)”). Details regarding the training of these signatures are discussed in Afsari, et al. (2021, ELife).

    names(supersig_ls)
    #>  [1] "AGE (LAML)"      "AGE (BLCA)"      "AGE (LUAD)"      "AGE (LGG)"
    #>  [5] "AGE (HNSCC)"     "AGE (KIRC)"      "AGE (KIRP)"      "AGE (KICH)"
    #>  [9] "AGE (LIHC)"      "AGE (STAD)"      "AGE (THCA)"      "AGE (UVM)"
    #> [13] "AGE (SKCM)"      "AGE (ACC)"       "AGE (CHOL)"      "AGE (GBM)"
    #> [17] "AGE (CESC)"      "AGE (COAD)"      "AGE (PCPG)"      "AGE (PAAD)"
    #> [21] "AGE (PRAD)"      "AGE (ESCSQ)"     "AGE (ESCAD)"     "AGE (UCEC)"
    #> [25] "AGE (UCS)"       "AGE (BRCA)"      "AGE (SARC)"      "AGE (TGCT)"
    #> [29] "AGE (THYM)"      "AGE (OV)"        "SMOKING (BLCA)"  "SMOKING (LUAD)"
    #> [33] "SMOKING (HNSCC)" "SMOKING (KIRP)"  "SMOKING (PAAD)"  "SMOKING (ESCSQ)"
    #> [37] "SMOKING (ESCAD)" "SMOKING (CESC)"  "POLE (UCEC)"     "POLE (STAD)"
    #> [41] "POLE (COAD)"     "POLE (BRCA)"     "MSI (UCEC)"      "MSI (STAD)"
    #> [45] "MSI (COAD)"      "BRCA (BRCA)"     "BRCA (OV)"       "UV* (SKCM)"
    #> [49] "POLD (UCEC)"     "POLD (STAD)"     "MGMT (GBM)"      "MGMT (LGG)"
    #> [53] "IDH (LGG)"       "IDH (GBM)"       "BMI (UCEC)"      "BMI (KIRP)"
    #> [57] "BMI (ESCA)"      "BMI (COAD)"      "ALCOHOL (HNSCC)" "ALCOHOL (ESCA)"
    #> [61] "ALCOHOL (LIHC)"  "HepB (LIHC)"     "HepC (LIHC)"     "AAcid (BLCA)"
    #> [65] "Asb* (MESO)"     "APOPEC (CESC)"   "APOPEC (KIRC)"

    # Use pre-trained signature
    newdata = predict_signature(supersig_ls[["SMOKING (LUAD)"]],
                                newdata = input_dt, factor = "Smoking")
    newdata %>%
      select(IndVar, X1, X2, X3, score)
    #> # A tibble: 5 × 5
    #>   IndVar     X1    X2    X3 score
    #>    <dbl>  <dbl> <dbl> <dbl> <dbl>
    #> 1      1 0.02       0     0 0.305
    #> 2      1 0.0182     0     0 0.303
    #> 3      1 0          0     0 0.280
    #> 4      0 0.0189     0     0 0.304
    #> 5      0 0.0417     0     0 0.333

# Partially supervised signatures

In some cases, you may be interested in removing the contribution of a supervised signature from your data frame of mutations as a way to adjust for a particular factor. For example, suppose that we are interested in the deciphering a signature for smoking in lung cancer. We can first remove the contribution of the aging signature in lung cancer, before learning the smoking signature with a supervised or unsupervised method. We discuss in Afsari, et al. (2021, ELife) how doing so can lead to better performance.

    adjusted_dt <- partial_signature(data = input_dt, object = supersig)
    head(adjusted_dt)
    #> # A tibble: 5 × 99
    #>   IndVar sample_id   AGE `A[T>G]T` `C[T>A]A` `G[C>A]A` `G[C>G]G` `G[C>G]T`
    #>    <dbl>     <dbl> <dbl>     <dbl>     <dbl>     <dbl>     <dbl>     <dbl>
    #> 1      1         1    50         1         1    1.04           1    1.04
    #> 2      1         2    55         0         0    0.0411         0    0.0411
    #> 3      1         3    72         1         1    0.0538         0    0.0538
    #> 4      0         4    53         0         0    0.0396         0    0.0396
    #> 5      0         5    48         0         1    1.04           0    0.0359
    #> # ℹ 91 more variables: `A[C>G]T` <dbl>, `C[C>A]T` <dbl>, `C[T>C]G` <dbl>,
    #> #   `T[C>A]C` <dbl>, `T[C>A]T` <dbl>, `A[T>C]C` <dbl>, `C[T>C]C` <dbl>,
    #> #   `T[T>A]C` <dbl>, `C[C>G]G` <dbl>, `G[C>T]A` <dbl>, `A[C>A]T` <dbl>,
    #> #   `C[C>A]C` <dbl>, `G[T>G]T` <dbl>, `C[C>T]C` <dbl>, `T[C>T]C` <dbl>,
    #> #   `A[C>T]C` <dbl>, `G[C>T]C` <dbl>, `C[C>T]T` <dbl>, `T[C>T]T` <dbl>,
    #> #   `A[C>T]T` <dbl>, `G[C>T]T` <dbl>, `C[C>T]A` <dbl>, `T[C>T]A` <dbl>,
    #> #   `A[C>T]A` <dbl>, `C[C>T]G` <dbl>, `T[C>T]G` <dbl>, `A[C>T]G` <dbl>, …

# Session info

    sessionInfo()
    #> R version 4.4.0 beta (2024-04-15 r86425 ucrt)
    #> Platform: x86_64-w64-mingw32/x64
    #> Running under: Windows Server 2022 x64 (build 20348)
    #>
    #> Matrix products: default
    #>
    #>
    #> locale:
    #> [1] LC_COLLATE=C
    #> [2] LC_CTYPE=English_United States.utf8
    #> [3] LC_MONETARY=English_United States.utf8
    #> [4] LC_NUMERIC=C
    #> [5] LC_TIME=English_United States.utf8
    #>
    #> time zone: America/New_York
    #> tzcode source: internal
    #>
    #> attached base packages:
    #> [1] stats4    stats     graphics  grDevices utils     datasets  methods
    #> [8] base
    #>
    #> other attached packages:
    #>  [1] ggplot2_3.5.1                     dplyr_1.1.4
    #>  [3] BSgenome.Hsapiens.UCSC.hg19_1.4.3 BSgenome_1.72.0
    #>  [5] rtracklayer_1.64.0                BiocIO_1.14.0
    #>  [7] VariantAnnotation_1.50.0          Rsamtools_2.20.0
    #>  [9] Biostrings_2.72.0                 XVector_0.44.0
    #> [11] SummarizedExperiment_1.34.0       Biobase_2.64.0
    #> [13] GenomicRanges_1.56.0              GenomeInfoDb_1.40.0
    #> [15] IRanges_2.38.0                    S4Vectors_0.42.0
    #> [17] MatrixGenerics_1.16.0             matrixStats_1.3.0
    #> [19] BiocGenerics_0.50.0               supersigs_1.12.0
    #>
    #> loaded via a namespace (and not attached):
    #>   [1] DBI_1.2.2                bitops_1.0-7             pROC_1.18.5
    #>   [4] rlang_1.1.3              magrittr_2.0.3           furrr_0.3.1
    #>   [7] RSQLite_2.3.6            compiler_4.4.0           GenomicFeatures_1.56.0
    #>  [10] png_0.1-8                vctrs_0.6.5              reshape2_1.4.4
    #>  [13] stringr_1.5.1            pkgconfig_2.0.3          crayon_1.5.2
    #>  [16] fastmap_1.1.1            labeling_0.4.3           utf8_1.2.4
    #>  [19] rmarkdown_2.26           prodlim_2023.08.28       UCSC.utils_1.0.0
    #>  [22] bit_4.0.5                purrr_1.0.2              xfun_0.43
    #>  [25] zlibbioc_1.50.0          cachem_1.0.8             jsonlite_1.8.8
    #>  [28] blob_1.2.4               recipes_1.0.10           highr_0.10
    #>  [31] DelayedArray_0.30.0      BiocParallel_1.38.0      parallel_4.4.0
    #>  [34] R6_2.5.1                 bslib_0.7.0              stringi_1.8.3
    #>  [37] rsample_1.2.1            parallelly_1.37.1        rpart_4.1.23
    #>  [40] lubridate_1.9.3          jquerylib_0.1.4          Rcpp_1.0.12
    #>  [43] assertthat_0.2.1         iterators_1.0.14         knitr_1.46
    #>  [46] future.apply_1.11.2      Matrix_1.7-0             splines_4.4.0
    #>  [49] nnet_7.3-19              timechange_0.3.0         tidyselect_1.2.1
    #>  [52] abind_1.4-5              yaml_2.3.8               timeDate_4032.109
    #>  [55] codetools_0.2-20         curl_5.2.1               listenv_0.9.1
    #>  [58] lattice_0.22-6           tibble_3.2.1             plyr_1.8.9
    #>  [61] KEGGREST_1.44.0          withr_3.0.0              evaluate_0.23
    #>  [64] future_1.33.2            survival_3.6-4           pillar_1.9.0
    #>  [67] foreach_1.5.2            generics_0.1.3           RCurl_1.98-1.14
    #>  [70] munsell_0.5.1            scales_1.3.0             globals_0.16.3
    #>  [73] class_7.3-22             glue_1.7.0               tools_4.4.0
    #>  [76] data.table_1.15.4        GenomicAlignments_1.40.0 ModelMetrics_1.2.2.2
    #>  [79] gower_1.0.1              XML_3.99-0.16.1          grid_4.4.0
    #>  [82] tidyr_1.3.1              AnnotationDbi_1.66.0     ipred_0.9-14
    #>  [85] colorspace_2.1-0         nlme_3.1-164             GenomeInfoDbData_1.2.12
    #>  [88] restfulr_0.0.15          cli_3.6.2                fansi_1.0.6
    #>  [91] S4Arrays_1.4.0           lava_1.8.0               gtable_0.3.5
    #>  [94] sass_0.4.9               digest_0.6.35            caret_6.0-94
    #>  [97] SparseArray_1.4.0        farver_2.1.1             rjson_0.2.21
    #> [100] memoise_2.0.1            htmltools_0.5.8.1        lifecycle_1.0.4
    #> [103] hardhat_1.3.1            httr_1.4.7               bit64_4.0.5
    #> [106] MASS_7.3-60.2