Installation

KGExplorer is now available via ghcr.io as a containerised environment with Rstudio and all necessary dependencies pre-installed.

Method 1: via Docker

First, install Docker if you have not already.

Create an image of the Docker container in command line:

docker pull ghcr.io/neurogenomics/KGExplorer

Once the image has been created, you can launch it with:

docker run \
  -d \
  -e ROOT=true \
  -e PASSWORD="<your_password>" \
  -v ~/Desktop:/Desktop \
  -v /Volumes:/Volumes \
  -p 8900:8787 \
  ghcr.io/neurogenomics/KGExplorer

NOTES

  • Make sure to replace <your_password> above with whatever you want your password to be.
  • Change the paths supplied to the -v flags for your particular use case.
  • The -d ensures the container will run in “detached” mode, which means it will persist even after you’ve closed your command line session.
  • The username will be “rstudio” by default.
  • Optionally, you can also install the Docker Desktop to easily manage your containers.

Method 2: via Singularity

If you are using a system that does not allow Docker (as is the case for many institutional computing clusters), you can instead install Docker images via Singularity.

singularity pull docker://ghcr.io/neurogenomics/KGExplorer

For troubleshooting, see the Singularity documentation.

Usage

Finally, launch the containerised Rstudio by entering the following URL in any web browser: http://localhost:8900/

Login using the credentials set during the Installation steps.

Session Info

utils::sessionInfo()
## R Under development (unstable) (2025-12-01 r89083)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.3 LTS
## 
## Matrix products: default
## BLAS:   /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 
## LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.26.so;  LAPACK version 3.12.0
## 
## locale:
##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
##  [3] LC_TIME=en_US.UTF-8        LC_COLLATE=en_US.UTF-8    
##  [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: UTC
## tzcode source: system (glibc)
## 
## attached base packages:
## [1] stats     graphics  grDevices utils     datasets  methods   base     
## 
## other attached packages:
## [1] KGExplorer_0.99.10
## 
## loaded via a namespace (and not attached):
##   [1] RColorBrewer_1.1-3        jsonlite_2.0.0           
##   [3] shape_1.4.6.1             magrittr_2.0.4           
##   [5] farver_2.1.2              rmarkdown_2.30           
##   [7] GlobalOptions_0.1.3       fs_1.6.6                 
##   [9] ragg_1.5.0                vctrs_0.6.5              
##  [11] ggtree_4.1.1              rstatix_0.7.3            
##  [13] htmltools_0.5.9           broom_1.0.11             
##  [15] Formula_1.2-5             gridGraphics_0.5-1       
##  [17] sass_0.4.10               bslib_0.9.0              
##  [19] htmlwidgets_1.6.4         desc_1.4.3               
##  [21] httr2_1.2.1               plotly_4.11.0            
##  [23] cachem_1.1.0              igraph_2.2.1             
##  [25] mime_0.13                 lifecycle_1.0.4          
##  [27] iterators_1.0.14          pkgconfig_2.0.3          
##  [29] Matrix_1.7-4              R6_2.6.1                 
##  [31] fastmap_1.2.0             shiny_1.12.0             
##  [33] clue_0.3-66               digest_0.6.39            
##  [35] aplot_0.2.9               colorspace_2.1-2         
##  [37] patchwork_1.3.2           S4Vectors_0.49.0         
##  [39] grr_0.9.5                 textshaping_1.0.4        
##  [41] ggpubr_0.6.2              httr_1.4.7               
##  [43] abind_1.4-8               compiler_4.6.0           
##  [45] fontquiver_0.2.1          doParallel_1.0.17        
##  [47] S7_0.2.1                  backports_1.5.0          
##  [49] BiocParallel_1.45.0       orthogene_1.17.0         
##  [51] carData_3.0-5             homologene_1.4.68.19.3.27
##  [53] maps_3.4.3                ggsignif_0.6.4           
##  [55] rappdirs_0.3.3            rjson_0.2.23             
##  [57] scatterplot3d_0.3-44      tools_4.6.0              
##  [59] otel_0.2.0                ape_5.8-1                
##  [61] httpuv_1.6.16             glue_1.8.0               
##  [63] rols_2.99.5               nlme_3.1-168             
##  [65] promises_1.5.0            grid_4.6.0               
##  [67] cluster_2.1.8.1           generics_0.1.4           
##  [69] gtable_0.3.6              tidyr_1.3.1              
##  [71] data.table_1.17.8         tidygraph_1.3.1          
##  [73] xml2_1.5.1                car_3.1-3                
##  [75] BiocGenerics_0.57.0       foreach_1.5.2            
##  [77] pillar_1.11.1             stringr_1.6.0            
##  [79] yulab.utils_0.2.2         babelgene_22.9           
##  [81] pals_1.10                 later_1.4.4              
##  [83] circlize_0.4.16           dplyr_1.1.4              
##  [85] treeio_1.35.0             lattice_0.22-7           
##  [87] tidyselect_1.2.1          fontLiberation_0.1.0     
##  [89] ComplexHeatmap_2.27.0     knitr_1.50               
##  [91] fontBitstreamVera_0.1.1   IRanges_2.45.0           
##  [93] stats4_4.6.0              xfun_0.54                
##  [95] Biobase_2.71.0            matrixStats_1.5.0        
##  [97] stringi_1.8.7             lazyeval_0.2.2           
##  [99] ggfun_0.2.0               yaml_2.3.11              
## [101] evaluate_1.0.5            codetools_0.2-20         
## [103] gdtools_0.4.4             tibble_3.3.0             
## [105] ggplotify_0.1.3           Polychrome_1.5.4         
## [107] cli_3.6.5                 xtable_1.8-4             
## [109] systemfonts_1.3.1         jquerylib_0.1.4          
## [111] dichromat_2.0-0.1         Rcpp_1.1.0               
## [113] mapproj_1.2.12            gprofiler2_0.2.4         
## [115] png_0.1-8                 parallel_4.6.0           
## [117] simona_1.9.0              pkgdown_2.2.0            
## [119] ggplot2_4.0.1             viridisLite_0.4.2        
## [121] tidytree_0.4.6            ggiraph_0.9.2            
## [123] scales_1.4.0              purrr_1.2.0              
## [125] crayon_1.5.3              GetoptLong_1.1.0         
## [127] rlang_1.1.6               fastmatch_1.1-6          
## [129] rvest_1.0.5