
Compute Transcription Factor (TF) activity
compute.TFs.activity.RdInfers transcription factor (TF) activity from a gene expression matrix with decoupleR::decouple()
(Badia-i-Mompel et al., 2022). By default the univariate linear model ("ulm") is used.
The TF-target network can be provided by the user, obtained from prebuilt collections (CollecTRI from
OmnipathR or Dorothea from the dorothea package), or read from an ARACNe-inferred network.
Usage
compute.TFs.activity(
counts_norm,
TF.collection = "CollecTRI",
min_targets_size = 5,
universe = NULL,
cancer_type = NULL,
method = "ulm",
scale = TRUE,
return = TRUE,
file_name = NULL
)Arguments
- counts_norm
A gene expression matrix with genes (symbols) as rows and samples as columns, with unique sample names. The matrix should be log-normalized (e.g., log2(TPM + 1), log2CPM, etc.). A warning is given if it has values above 20, which log2(TPM + 1) cannot reach.
- TF.collection
Character. The source of the TF-target network. Options are
"CollecTRI"(default),"Dorothea", or"ARACNE"."CollecTRI"uses the prebuilt collection from OmnipathR and"Dorothea"(confidence A and B) the one from thedorotheapackage. Each collection is cached in its own file,Results/TF_target_collection_<TF.collection>.csv, and reused on later calls: a message gives the number of TFs and interactions of the cached file and the date it was saved. A cached file that is empty or lacks the columnssource,targetandmoris not used (the collection is obtained again, with a warning). Delete the file to obtain the collection again."ARACNE"reads a tab-separated network file withRegulatorandTargetcolumns frominput/ARACNE/<cancer_type>/network/network.txt(relative to the working directory). The mode of regulation of each edge is read from amorcolumn of the file (1 activation, -1 repression), which should be the sign of the Spearman correlation between TF and target computed on the cohort used to build the network. If the file has nomorcolumn, a warning is given and the signs are computed as the sign of the Spearman correlation between TF and target in the samples ofcounts_norm; they then depend on the samples given (e.g. they can differ between cohorts, or between a training and a test set).
- min_targets_size
Integer. Minimum number of target genes per regulon (passed to
decoupleR::decouple()asminsize). Default is 5.- universe
Optional. A user-specified data frame of TF-target interactions (columns
source,target,mor). The three columns are required:moris the mode of regulation (1 activation, -1 repression; use 1 for every edge if the network has no sign). If not provided, the network is fetched based onTF.collection. Ignored whenTF.collection = "ARACNE".- cancer_type
Optional character. TCGA cancer type abbreviation used to locate the ARACNe network (only used when
TF.collection = "ARACNE"). IfNULL, the network is auto-detected when only onenetwork.txtexists underinput/ARACNE/.- method
Character. The
decoupleRstatistic used to score the TFs:"ulm"(univariate linear model, default),"mlm"(multivariate linear model),"wsum"(weighted sum) or"consensus"(consensus of the three).- scale
Logical. If TRUE (default), z-score scales the TF activity matrix across samples. The scaled scores of a sample then depend on the other samples given in the same call; use
scale = FALSEto get scores that can be compared between separate calls (e.g. a training and a test set). With fewer than three samples the scores are not scaled (a message is given).- return
Logical; if TRUE, saves matrix in Results/ folder. Default is TRUE.
- file_name
Optional character suffix used when writing the TF activity matrix to disk (
Results/TF_matrix_<file_name>.csv; without it,Results/TF_matrix.csv).
Value
A data frame of inferred (and, if scale = TRUE, scaled) TF activity scores, with samples as rows
and TFs as columns. Column names are made syntactically valid with make.names() (e.g. NKX2.1),
in the returned table and in the saved file.
References
Badia-i-Mompel, P. et al. (2022). decoupleR: ensemble of computational methods to infer biological activities from omics data. Bioinformatics Advances, 2(1), vbac016. https://doi.org/10.1093/bioadv/vbac016
Tuerei, D., Korcsmaros, T., & Saez-Rodriguez, J. (2016). OmniPath: guidelines and gateway for literature-curated signaling pathway resources. Nature Methods, 13(12), 966-967. https://doi.org/10.1038/nmeth.4077
Garcia-Alonso, L. et al. (2019). Benchmark and integration of resources for the estimation of human transcription factor activities. Genome Research. https://doi.org/10.1101/gr.240663.118
Lachmann, A. et al. (2016). ARACNe-AP: gene network reverse engineering through adaptive partitioning inference of mutual information. Bioinformatics, 32(14), 2233-2235. https://doi.org/10.1093/bioinformatics/btw216
Margolin, A.A. et al. (2006). ARACNE: an algorithm for the reconstruction of gene regulatory networks in a mammalian cellular context. BMC Bioinformatics, 7(Suppl 1), S7. https://doi.org/10.1186/1471-2105-7-S1-S7
Examples
if (FALSE) { # \dontrun{
# Downloads the CollecTRI network from OmniPath
data("counts.norm.tuto")
tfs_activity <- compute.TFs.activity(counts.norm.tuto)
} # }