---
title: "Overview of the tidybulk package"
author: "Stefano Mangiola"
date: "`r Sys.Date()`"
package: tidybulk
output:
BiocStyle::html_document:
toc_float: true
vignette: >
%\VignetteEngine{knitr::knitr}
%\VignetteIndexEntry{Overview of the tidybulk package}
%\usepackage[UTF-8]{inputenc}
---
**Brings transcriptomics to the tidyverse**
```{r, echo=FALSE, out.width = "800px"}
knitr::include_graphics("../man/figures/new_SE_usage-01.png")
```
## Functions/utilities available
Function | Description
------------ | -------------
`identify_abundant` | identify the abundant genes
`aggregate_duplicates` | Aggregate abundance and annotation of duplicated transcripts in a robust way
`scale_abundance` | Scale (normalise) abundance for RNA sequencing depth
`reduce_dimensions` | Perform dimensionality reduction (PCA, MDS, tSNE)
`cluster_elements` | Labels elements with cluster identity (kmeans, SNN)
`remove_redundancy` | Filter out elements with highly correlated features
`adjust_abundance` | Remove known unwanted variation (Combat)
`test_differential_abundance` | Differential transcript abundance testing (DE)
`deconvolve_cellularity` | Estimated tissue composition (Cibersort or llsr)
`test_differential_cellularity` | Differential cell-type abundance testing
`keep_variable` | Filter for top variable features
`keep_abundant` | Filter out lowly abundant transcripts
`test_gene_enrichment` | Gene enrichment analyses (EGSEA)
`test_gene_overrepresentation` | Gene enrichment on list of transcript names (no rank)
Utilities | Description
------------ | -------------
`get_bibliography` | Get the bibliography of your workflow
`tidybulk` | add tidybulk attributes to a tibble object
`tidybulk_SAM_BAM` | Convert SAM BAM files into tidybulk tibble
`pivot_sample` | Select sample-wise columns/information
`pivot_transcript` | Select transcript-wise columns/information
`rotate_dimensions` | Rotate two dimensions of a degree
`ensembl_to_symbol` | Add gene symbol from ensembl IDs
`symbol_to_entrez` | Add entrez ID from gene symbol
`describe_transcript` | Add gene description from gene symbol
`impute_missing_abundance` | Impute abundance for missing data points using sample groupings
`fill_missing_abundance` | Fill abundance for missing data points using an arbitrary value
All functions are directly compatibble with `SummarizedExperiment` object.
```{r, echo=FALSE, include=FALSE, }
library(knitr)
# knitr::opts_chunk$set(cache = TRUE, warning = FALSE,
# message = FALSE, cache.lazy = FALSE)
library(dplyr)
library(tidyr)
library(tibble)
library(magrittr)
library(ggplot2)
library(ggrepel)
library(tidybulk)
library(tidySummarizedExperiment)
my_theme =
theme_bw() +
theme(
panel.border = element_blank(),
axis.line = element_line(),
panel.grid.major = element_line(size = 0.2),
panel.grid.minor = element_line(size = 0.1),
text = element_text(size=12),
legend.position="bottom",
aspect.ratio=1,
strip.background = element_blank(),
axis.title.x = element_text(margin = margin(t = 10, r = 10, b = 10, l = 10)),
axis.title.y = element_text(margin = margin(t = 10, r = 10, b = 10, l = 10))
)
data(se_mini)
tibble_counts = tidybulk::se_mini |> tidybulk() |> as_tibble()
```
## Installation
From Bioconductor
```{r eval=FALSE}
BiocManager::install("tidybulk")
```
From Github
```{r, eval=FALSE}
devtools::install_github("stemangiola/tidybulk")
```
# Data
We will use a `SummarizedExperiment` object
```{r}
se_mini
```
Loading `tidySummarizedExperiment` will automatically abstract this object as `tibble`, so we can display it and manipulate it with tidy tools. Although it looks different, and more tools (tidyverse) are available to us, this object is in fact a `SummarizedExperiment` object.
```{r}
class(se_mini)
```
## Get the bibliography of your workflow
First of all, you can cite all articles utilised within your workflow automatically from any tidybulk tibble
```{r eval=FALSE}
se_mini |> get_bibliography()
```
## Aggregate duplicated `transcripts`
tidybulk provide the `aggregate_duplicates` function to aggregate duplicated transcripts (e.g., isoforms, ensembl). For example, we often have to convert ensembl symbols to gene/transcript symbol, but in doing so we have to deal with duplicates. `aggregate_duplicates` takes a tibble and column names (as symbols; for `sample`, `transcript` and `count`) as arguments and returns a tibble with transcripts with the same name aggregated. All the rest of the columns are appended, and factors and boolean are appended as characters.
TidyTranscriptomics
```{r aggregate, message=FALSE, warning=FALSE, results='hide', class.source='yellow'}
rowData(se_mini)$gene_name = rownames(se_mini)
se_mini.aggr = se_mini |> aggregate_duplicates(.transcript = gene_name)
```
Standard procedure (comparative purpose)
```{r aggregate long, eval=FALSE}
temp = data.frame(
symbol = dge_list$genes$symbol,
dge_list$counts
)
dge_list.nr <- by(temp, temp$symbol,
function(df)
if(length(df[1,1])>0)
matrixStats:::colSums(as.matrix(df[,-1]))
)
dge_list.nr <- do.call("rbind", dge_list.nr)
colnames(dge_list.nr) <- colnames(dge_list)
```
## Scale `counts`
We may want to compensate for sequencing depth, scaling the transcript abundance (e.g., with TMM algorithm, Robinson and Oshlack doi.org/10.1186/gb-2010-11-3-r25). `scale_abundance` takes a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and a method as arguments and returns a tibble with additional columns with scaled data as `_scaled`.
TidyTranscriptomics
```{r normalise}
se_mini.norm = se_mini.aggr |> identify_abundant(factor_of_interest = condition) |> scale_abundance()
```
Standard procedure (comparative purpose)
```{r normalise long, eval=FALSE}
library(edgeR)
dgList <- DGEList(count_m=x,group=group)
keep <- filterByExpr(dgList)
dgList <- dgList[keep,,keep.lib.sizes=FALSE]
[...]
dgList <- calcNormFactors(dgList, method="TMM")
norm_counts.table <- cpm(dgList)
```
```{r, include=FALSE}
se_mini.norm |> select(`count`, count_scaled, .abundant, everything())
```
We can easily plot the scaled density to check the scaling outcome. On the x axis we have the log scaled counts, on the y axes we have the density, data is grouped by sample and coloured by cell type.
```{r plot_normalise}
se_mini.norm |>
ggplot(aes(count_scaled + 1, group=.sample, color=`Cell.type`)) +
geom_density() +
scale_x_log10() +
my_theme
```
## Filter `variable transcripts`
We may want to identify and filter variable transcripts.
TidyTranscriptomics
```{r filter variable}
se_mini.norm.variable = se_mini.norm |> keep_variable()
```
Standard procedure (comparative purpose)
```{r filter variable long, eval=FALSE}
library(edgeR)
x = norm_counts.table
s <- rowMeans((x-rowMeans(x))^2)
o <- order(s,decreasing=TRUE)
x <- x[o[1L:top],,drop=FALSE]
norm_counts.table = norm_counts.table[rownames(x)]
norm_counts.table$cell_type = tibble_counts[
match(
tibble_counts$sample,
rownames(norm_counts.table)
),
"Cell.type"
]
```
## Reduce `dimensions`
We may want to reduce the dimensions of our data, for example using PCA or MDS algorithms. `reduce_dimensions` takes a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and a method (e.g., MDS or PCA) as arguments and returns a tibble with additional columns for the reduced dimensions.
**MDS** (Robinson et al., 10.1093/bioinformatics/btp616)
TidyTranscriptomics
```{r mds}
se_mini.norm.MDS =
se_mini.norm |>
reduce_dimensions(method="MDS", .dims = 3)
```
Standard procedure (comparative purpose)
```{r, eval = FALSE}
library(limma)
count_m_log = log(count_m + 1)
cmds = limma::plotMDS(ndim = .dims, plot = FALSE)
cmds = cmds %$%
cmdscale.out |>
setNames(sprintf("Dim%s", 1:6))
cmds$cell_type = tibble_counts[
match(tibble_counts$sample, rownames(cmds)),
"Cell.type"
]
```
On the x and y axes axis we have the reduced dimensions 1 to 3, data is coloured by cell type.
```{r plot_mds, eval=FALSE}
se_mini.norm.MDS |> pivot_sample() |> select(contains("Dim"), everything())
se_mini.norm.MDS |>
pivot_sample() |>
GGally::ggpairs(columns = 9:11, ggplot2::aes(colour=`Cell.type`))
```
**PCA**
TidyTranscriptomics
```{r pca, message=FALSE, warning=FALSE, results='hide'}
se_mini.norm.PCA =
se_mini.norm |>
reduce_dimensions(method="PCA", .dims = 3)
```
Standard procedure (comparative purpose)
```{r,eval=FALSE}
count_m_log = log(count_m + 1)
pc = count_m_log |> prcomp(scale = TRUE)
variance = pc$sdev^2
variance = (variance / sum(variance))[1:6]
pc$cell_type = counts[
match(counts$sample, rownames(pc)),
"Cell.type"
]
```
On the x and y axes axis we have the reduced dimensions 1 to 3, data is coloured by cell type.
```{r plot_pca, eval=FALSE}
se_mini.norm.PCA |> pivot_sample() |> select(contains("PC"), everything())
se_mini.norm.PCA |>
pivot_sample() |>
GGally::ggpairs(columns = 11:13, ggplot2::aes(colour=`Cell.type`))
```
**tSNE**
TidyTranscriptomics
```{r tsne, message=FALSE, warning=FALSE, results='hide'}
se_mini.norm.tSNE =
breast_tcga_mini_SE |>
identify_abundant() |>
reduce_dimensions(
method = "tSNE",
perplexity=10,
pca_scale =TRUE
)
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
count_m_log = log(count_m + 1)
tsne = Rtsne::Rtsne(
t(count_m_log),
perplexity=10,
pca_scale =TRUE
)$Y
tsne$cell_type = tibble_counts[
match(tibble_counts$sample, rownames(tsne)),
"Cell.type"
]
```
Plot
```{r}
se_mini.norm.tSNE |>
pivot_sample() |>
select(contains("tSNE"), everything())
se_mini.norm.tSNE |>
pivot_sample() |>
ggplot(aes(x = `tSNE1`, y = `tSNE2`, color=Call)) + geom_point() + my_theme
```
## Rotate `dimensions`
We may want to rotate the reduced dimensions (or any two numeric columns really) of our data, of a set angle. `rotate_dimensions` takes a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and an angle as arguments and returns a tibble with additional columns for the rotated dimensions. The rotated dimensions will be added to the original data set as ` rotated ` by default, or as specified in the input arguments.
TidyTranscriptomics
```{r rotate}
se_mini.norm.MDS.rotated =
se_mini.norm.MDS |>
rotate_dimensions(`Dim1`, `Dim2`, rotation_degrees = 45, action="get")
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
rotation = function(m, d) {
r = d * pi / 180
((bind_rows(
c(`1` = cos(r), `2` = -sin(r)),
c(`1` = sin(r), `2` = cos(r))
) |> as_matrix()) %*% m)
}
mds_r = pca |> rotation(rotation_degrees)
mds_r$cell_type = counts[
match(counts$sample, rownames(mds_r)),
"Cell.type"
]
```
**Original**
On the x and y axes axis we have the first two reduced dimensions, data is coloured by cell type.
```{r plot_rotate_1}
se_mini.norm.MDS.rotated |>
ggplot(aes(x=`Dim1`, y=`Dim2`, color=`Cell.type` )) +
geom_point() +
my_theme
```
**Rotated**
On the x and y axes axis we have the first two reduced dimensions rotated of 45 degrees, data is coloured by cell type.
```{r plot_rotate_2}
se_mini.norm.MDS.rotated |>
pivot_sample() |>
ggplot(aes(x=`Dim1_rotated_45`, y=`Dim2_rotated_45`, color=`Cell.type` )) +
geom_point() +
my_theme
```
## Test `differential abundance`
We may want to test for differential transcription between sample-wise factors of interest (e.g., with edgeR). `test_differential_abundance` takes a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and a formula representing the desired linear model as arguments and returns a tibble with additional columns for the statistics from the hypothesis test (e.g., log fold change, p-value and false discovery rate).
TidyTranscriptomics
```{r de, message=FALSE, warning=FALSE, results='hide'}
se_mini.de =
se_mini |>
test_differential_abundance( ~ condition, action="get")
se_mini.de
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
library(edgeR)
dgList <- DGEList(counts=counts_m,group=group)
keep <- filterByExpr(dgList)
dgList <- dgList[keep,,keep.lib.sizes=FALSE]
dgList <- calcNormFactors(dgList)
design <- model.matrix(~group)
dgList <- estimateDisp(dgList,design)
fit <- glmQLFit(dgList,design)
qlf <- glmQLFTest(fit,coef=2)
topTags(qlf, n=Inf)
```
The functon `test_differential_abundance` operated with contrasts too. The constrasts hve the name of the design matrix (generally )
```{r de contrast, message=FALSE, warning=FALSE, results='hide', eval=FALSE}
se_mini.de =
se_mini |>
identify_abundant(factor_of_interest = condition) |>
test_differential_abundance(
~ 0 + condition,
.contrasts = c( "conditionTRUE - conditionFALSE"),
action="get"
)
```
## Adjust `counts`
We may want to adjust `counts` for (known) unwanted variation. `adjust_abundance` takes as arguments a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and a formula representing the desired linear model where the first covariate is the factor of interest and the second covariate is the unwanted variation, and returns a tibble with additional columns for the adjusted counts as `_adjusted`. At the moment just an unwanted covariates is allowed at a time.
TidyTranscriptomics
```{r adjust, message=FALSE, warning=FALSE, results='hide'}
se_mini.norm.adj =
se_mini.norm |> adjust_abundance( .factor_unwanted = time, .factor_of_interest = condition, method="combat")
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
library(sva)
count_m_log = log(count_m + 1)
design =
model.matrix(
object = ~ factor_of_interest + batch,
data = annotation
)
count_m_log.sva =
ComBat(
batch = design[,2],
mod = design,
...
)
count_m_log.sva = ceiling(exp(count_m_log.sva) -1)
count_m_log.sva$cell_type = counts[
match(counts$sample, rownames(count_m_log.sva)),
"Cell.type"
]
```
## Deconvolve `Cell type composition`
We may want to infer the cell type composition of our samples (with the algorithm Cibersort; Newman et al., 10.1038/nmeth.3337). `deconvolve_cellularity` takes as arguments a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and returns a tibble with additional columns for the adjusted cell type proportions.
TidyTranscriptomics
```{r cibersort}
se_mini.cibersort =
se_mini |>
deconvolve_cellularity(action="get", cores=1, prefix = "cibersort__")
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
source(‘CIBERSORT.R’)
count_m |> write.table("mixture_file.txt")
results <- CIBERSORT(
"sig_matrix_file.txt",
"mixture_file.txt",
perm=100, QN=TRUE
)
results$cell_type = tibble_counts[
match(tibble_counts$sample, rownames(results)),
"Cell.type"
]
```
With the new annotated data frame, we can plot the distributions of cell types across samples, and compare them with the nominal cell type labels to check for the purity of isolation. On the x axis we have the cell types inferred by Cibersort, on the y axis we have the inferred proportions. The data is facetted and coloured by nominal cell types (annotation given by the researcher after FACS sorting).
```{r plot_cibersort, eval=FALSE}
se_mini.cibersort |>
pivot_longer(
names_to= "Cell_type_inferred",
values_to = "proportion",
names_prefix ="cibersort__",
cols=contains("cibersort__")
) |>
ggplot(aes(x=Cell_type_inferred, y=proportion, fill=`Cell.type`)) +
geom_boxplot() +
facet_wrap(~`Cell.type`) +
my_theme +
theme(axis.text.x = element_text(angle = 90, hjust = 1, vjust = 0.5), aspect.ratio=1/5)
```
## Test differential cell-type abundance
We can also perform a statistical test on the differential cell-type abundance across conditions
```{r DC, eval=FALSE}
se_mini |>
test_differential_cellularity(. ~ condition )
```
We can also perform regression analysis with censored data (coxph).
```{r DC_censored, eval=FALSE}
se_mini |>
test_differential_cellularity(survival::Surv(time, dead) ~ .)
```
## Cluster `samples`
We may want to cluster our data (e.g., using k-means sample-wise). `cluster_elements` takes as arguments a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and returns a tibble with additional columns for the cluster annotation. At the moment only k-means clustering is supported, the plan is to introduce more clustering methods.
**k-means**
TidyTranscriptomics
```{r cluster}
se_mini.norm.cluster = se_mini.norm.MDS |>
cluster_elements(method="kmeans", centers = 2, action="get" )
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
count_m_log = log(count_m + 1)
k = kmeans(count_m_log, iter.max = 1000, ...)
cluster = k$cluster
cluster$cell_type = tibble_counts[
match(tibble_counts$sample, rownames(cluster)),
c("Cell.type", "Dim1", "Dim2")
]
```
We can add cluster annotation to the MDS dimension reduced data set and plot.
```{r plot_cluster}
se_mini.norm.cluster |>
ggplot(aes(x=`Dim1`, y=`Dim2`, color=`cluster_kmeans`)) +
geom_point() +
my_theme
```
**SNN**
Matrix package (v1.3-3) causes an error with Seurat::FindNeighbors used in this method. We are trying to solve this issue. At the moment this option in unaviable.
TidyTranscriptomics
```{r SNN, eval=FALSE, cache=TRUE, message=FALSE, warning=FALSE, results='hide'}
se_mini.norm.SNN =
se_mini.norm.tSNE |>
cluster_elements(method = "SNN")
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
library(Seurat)
snn = CreateSeuratObject(count_m)
snn = ScaleData(
snn, display.progress = TRUE,
num.cores=4, do.par = TRUE
)
snn = FindVariableFeatures(snn, selection.method = "vst")
snn = FindVariableFeatures(snn, selection.method = "vst")
snn = RunPCA(snn, npcs = 30)
snn = FindNeighbors(snn)
snn = FindClusters(snn, method = "igraph", ...)
snn = snn[["seurat_clusters"]]
snn$cell_type = tibble_counts[
match(tibble_counts$sample, rownames(snn)),
c("Cell.type", "Dim1", "Dim2")
]
```
```{r SNN_plot, eval=FALSE}
se_mini.norm.SNN |>
pivot_sample() |>
select(contains("tSNE"), everything())
se_mini.norm.SNN |>
pivot_sample() |>
gather(source, Call, c("cluster_SNN", "Call")) |>
distinct() |>
ggplot(aes(x = `tSNE1`, y = `tSNE2`, color=Call)) + geom_point() + facet_grid(~source) + my_theme
# Do differential transcription between clusters
se_mini.norm.SNN |>
mutate(factor_of_interest = `cluster_SNN` == 3) |>
test_differential_abundance(
~ factor_of_interest,
action="get"
)
```
## Drop `redundant` transcripts
We may want to remove redundant elements from the original data set (e.g., samples or transcripts), for example if we want to define cell-type specific signatures with low sample redundancy. `remove_redundancy` takes as arguments a tibble, column names (as symbols; for `sample`, `transcript` and `count`) and returns a tibble with redundant elements removed (e.g., samples). Two redundancy estimation approaches are supported:
+ removal of highly correlated clusters of elements (keeping a representative) with method="correlation"
+ removal of most proximal element pairs in a reduced dimensional space.
**Approach 1**
TidyTranscriptomics
```{r drop}
se_mini.norm.non_redundant =
se_mini.norm.MDS |>
remove_redundancy( method = "correlation" )
```
Standard procedure (comparative purpose)
```{r, eval=FALSE}
library(widyr)
.data.correlated =
pairwise_cor(
counts,
sample,
transcript,
rc,
sort = TRUE,
diag = FALSE,
upper = FALSE
) |>
filter(correlation > correlation_threshold) |>
distinct(item1) |>
rename(!!.element := item1)
# Return non redudant data frame
counts |> anti_join(.data.correlated) |>
spread(sample, rc, - transcript) |>
left_join(annotation)
```
We can visualise how the reduced redundancy with the reduced dimentions look like
```{r plot_drop}
se_mini.norm.non_redundant |>
pivot_sample() |>
ggplot(aes(x=`Dim1`, y=`Dim2`, color=`Cell.type`)) +
geom_point() +
my_theme
```
**Approach 2**
```{r drop2}
se_mini.norm.non_redundant =
se_mini.norm.MDS |>
remove_redundancy(
method = "reduced_dimensions",
Dim_a_column = `Dim1`,
Dim_b_column = `Dim2`
)
```
We can visualise MDS reduced dimensions of the samples with the closest pair removed.
```{r plot_drop2}
se_mini.norm.non_redundant |>
pivot_sample() |>
ggplot(aes(x=`Dim1`, y=`Dim2`, color=`Cell.type`)) +
geom_point() +
my_theme
```
## Other useful wrappers
The above wrapper streamline the most common processing of bulk RNA sequencing data. Other useful wrappers are listed above.
## From BAM/SAM to tibble of gene counts
We can calculate gene counts (using FeatureCounts; Liao Y et al., 10.1093/nar/gkz114) from a list of BAM/SAM files and format them into a tidy structure (similar to counts).
```{r eval=FALSE}
counts = tidybulk_SAM_BAM(
file_names,
genome = "hg38",
isPairedEnd = TRUE,
requireBothEndsMapped = TRUE,
checkFragLength = FALSE,
useMetaFeatures = TRUE
)
```
## From ensembl IDs to gene symbol IDs
We can add gene symbols from ensembl identifiers. This is useful since different resources use ensembl IDs while others use gene symbol IDs. This currently works for human and mouse.
```{r ensembl}
counts_ensembl |> ensembl_to_symbol(ens)
```
## From gene symbol to gene description (gene name in full)
We can add gene full name (and in future description) from symbol identifiers. This currently works for human and mouse.
```{r description}
se_mini |>
describe_transcript() |>
select(feature, description, everything())
```
## Appendix
```{r}
sessionInfo()
```