The Netboost users guide
29 October 2024
Package
netboost 2.14.0
Contents
1 Introduction
The netboost package, implements a three-step dimension reduction technique. First, a boosting-based filter is combined with the topological overlap measure to identify the essential edges of the network. Second, sparse hierarchical clustering is applied on the selected edges to identify modules and finally module information is aggregated by the first principal components. The primary analysis is then carried out on these summary measures instead of the original data.
2 Loading an example dataset
The package comes with an example dataset included. We import the acute myeloid leukemia patient data from The Cancer Genome Atlas public domain database. The dataset consists of one thousand DNA methylation sites and gene expression levels on chromosome 18 for 80 patients.
require("netboost")## Loading required package: netboost## ## netboost 2.14.0 loadedDefault CPU cores: 1data("tcga_aml_meth_rna_chr18", package = "netboost")
dim(tcga_aml_meth_rna_chr18)## [1] 80 500The netboost() function integrates all major analysis steps and generates
multiple plots. In this step we also set analysis parameters:
stepno defines the number of boosting steps taken
soft_power (if null, automatically chosen) the exponent in the transformation
of the correlation
min_cluster_size the minimal size of clusters, n_pc the number of maximally
computed principal components
scale if data should be scaled and centered prior to analysis
ME_diss_thres defines the merging threshold for identified clusters.
For details on the options please see ?netboost and the corresponding paper
Schlosser et al. 2020.
results <- netboost(datan = tcga_aml_meth_rna_chr18, stepno = 20L,
soft_power = 3L, min_cluster_size = 10L, n_pc = 2, scale = TRUE, ME_diss_thres = 0.25) ## idx: 1 (0.2%) - Tue Oct 29 21:53:23 2024
##
## Netboost extracted 10 modules (including background) with an average size of 17.5555555555556 (excluding background) from Tree 1.##
## Netboost detected 9 modules and 1 background modules in 1 trees resulting in 15 aggregate measures.## Average size of the modules was 17.5555555555556.## 342 of 500 features (68.4%) were not assigned to modules.For each detected independent tree in the dataset (here one) the first graph shows a dendrogram of initial modules and at which level they are merged, the second graph a module dendrogram after merging and the third the dendrogram of features including the module-color-code.
results contains the dendrograms (dendros), feature identifier (names) matched
to module assignment (colors), the aggregated dataset (MEs), the rotation matrix
to compute the aggregated dataset (rotation) and the proportion of variance
explained by the aggregate measures (var_explained).
Dependent on the minimum proportion of variance explained set in the
netboost() call (default 0.5) up to n_pc principal components are exported.
names(results)## [1] "dendros" "names" "colors" "MEs"
## [5] "rotation" "var_explained" "filter"colnames(results$MEs)## [1] "ME0_1_pc1" "ME0_1_pc2" "ME7_pc1" "ME1_pc1" "ME1_pc2" "ME2_pc1"
## [7] "ME2_pc2" "ME8_pc1" "ME5_pc1" "ME3_pc1" "ME3_pc2" "ME4_pc1"
## [13] "ME4_pc2" "ME9_pc1" "ME6_pc1"As you see for most modules the first principal component already explained more than 50% of the variance in the original features of this module. ME0_X_pcY denotes the background module (unclustered features) of the independent tree X.
Explained variance is reported by a matrix for the first n_pc principal
components. Here we list the first 5 modules:
results$var_explained[,1:5]## ME0_1 ME7 ME1 ME2 ME8
## PC1 0.06700469 0.61004480 0.4403646 0.49237958 0.59426699
## PC2 0.05502278 0.07484705 0.1174992 0.07779346 0.08341562results$colors use a numeric coding for the modules which matches their module
name. To list features of module ME8 we can extract them by:
results$names[results$colors==8]## [1] "cg00027037" "cg00034852" "cg00220661" "cg00228017" "cg00366917"
## [6] "cg00430895" "cg00474194" "cg00481457" "cg00511081" "cg00539368"
## [11] "cg00576121" "cg00615915" "cg00736530" "cg00917154" "cg00940278"
## [16] "cg00955482"The final dendrogram including all trees can be plotted including labels (results$names) for
individual features. colorsrandom controls if module-color matching should be
randomized to get a clearly differentiable pattern of the potentially many
modules. Labels are only suitable in applications with few features or with a
appropriately large pdf device.
set.seed(123)
nb_plot_dendro(nb_summary = results, labels = FALSE, colorsrandom = TRUE)
Next the primary analysis on the aggregated dataset (results$MEs) can be
computed.
We also implemented a convenience function to transfer a clustering to a new
dataset. Here, we transfer the clustering to the same dataset resulting in
identical aggregate measures.
ME_transfer <- nb_transfer(nb_summary = results,
new_data = tcga_aml_meth_rna_chr18, scale = TRUE)
all(round(results$MEs, 10) == round(ME_transfer, 10))## [1] TRUENetboost now also has a fully non-parametric implementation. Code is not run here to showcase the multicore option (Bioconductor vignette builder does not allow for multicore execution). Adjust cores to your machine:
#results <- netboost(datan = tcga_aml_meth_rna_chr18,cores=10L,
#soft_power = 3L, min_cluster_size = 10L, n_pc = 2, qc_plot = FALSE,
#filter_method = "spearman", robust_PCs = TRUE, method = "spearman")3 Session Info
sessionInfo()## R version 4.4.1 (2024-06-14)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.20-bioc/R/lib/libRblas.so
## LAPACK: /usr/lib/x86_64-linux-gnu/lapack/liblapack.so.3.12.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] stats graphics grDevices utils datasets methods base
##
## other attached packages:
## [1] netboost_2.14.0 BiocStyle_2.34.0
##
## loaded via a namespace (and not attached):
## [1] DBI_1.2.3 gridExtra_2.3 rlang_1.1.4
## [4] magrittr_2.0.3 matrixStats_1.4.1 compiler_4.4.1
## [7] RSQLite_2.3.7 png_0.1-8 vctrs_0.6.5
## [10] stringr_1.5.1 pkgconfig_2.0.3 crayon_1.5.3
## [13] fastmap_1.2.0 magick_2.8.5 backports_1.5.0
## [16] XVector_0.46.0 utf8_1.2.4 rmarkdown_2.28
## [19] UCSC.utils_1.2.0 preprocessCore_1.68.0 tinytex_0.53
## [22] bit_4.5.0 xfun_0.48 zlibbioc_1.52.0
## [25] cachem_1.1.0 GenomeInfoDb_1.42.0 jsonlite_1.8.9
## [28] blob_1.2.4 highr_0.11 parallel_4.4.1
## [31] cluster_2.1.6 R6_2.5.1 bslib_0.8.0
## [34] stringi_1.8.4 rpart_4.1.23 jquerylib_0.1.4
## [37] Rcpp_1.0.13 bookdown_0.41 iterators_1.0.14
## [40] knitr_1.48 WGCNA_1.73 base64enc_0.1-3
## [43] R.utils_2.12.3 IRanges_2.40.0 Matrix_1.7-1
## [46] splines_4.4.1 nnet_7.3-19 tidyselect_1.2.1
## [49] rstudioapi_0.17.1 yaml_2.3.10 doParallel_1.0.17
## [52] codetools_0.2-20 lattice_0.22-6 tibble_3.2.1
## [55] Biobase_2.66.0 KEGGREST_1.46.0 evaluate_1.0.1
## [58] foreign_0.8-87 survival_3.7-0 RcppParallel_5.1.9
## [61] Biostrings_2.74.0 pillar_1.9.0 BiocManager_1.30.25
## [64] checkmate_2.3.2 foreach_1.5.2 stats4_4.4.1
## [67] generics_0.1.3 S4Vectors_0.44.0 ggplot2_3.5.1
## [70] munsell_0.5.1 scales_1.3.0 glue_1.8.0
## [73] Hmisc_5.2-0 tools_4.4.1 data.table_1.16.2
## [76] fastcluster_1.2.6 grid_4.4.1 impute_1.80.0
## [79] AnnotationDbi_1.68.0 colorspace_2.1-1 GenomeInfoDbData_1.2.13
## [82] htmlTable_2.4.3 Formula_1.2-5 cli_3.6.3
## [85] fansi_1.0.6 dplyr_1.1.4 gtable_0.3.6
## [88] R.methodsS3_1.8.2 dynamicTreeCut_1.63-1 sass_0.4.9
## [91] digest_0.6.37 BiocGenerics_0.52.0 htmlwidgets_1.6.4
## [94] memoise_2.0.1 htmltools_0.5.8.1 R.oo_1.26.0
## [97] lifecycle_1.0.4 httr_1.4.7 GO.db_3.20.0
## [100] bit64_4.5.2warnings()