Installation

orthogene 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/orthogene

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/orthogene

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/orthogene

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 version 4.4.2 (2024-10-31)
## Platform: x86_64-pc-linux-gnu
## Running under: Ubuntu 24.04.1 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] orthogene_1.13.01 BiocStyle_2.34.0 
## 
## loaded via a namespace (and not attached):
##  [1] gtable_0.3.6              babelgene_22.9           
##  [3] xfun_0.51                 bslib_0.9.0              
##  [5] ggplot2_3.5.1             htmlwidgets_1.6.4        
##  [7] rstatix_0.7.2             lattice_0.22-6           
##  [9] vctrs_0.6.5               tools_4.4.2              
## [11] generics_0.1.3            yulab.utils_0.2.0        
## [13] parallel_4.4.2            tibble_3.2.1             
## [15] pkgconfig_2.0.3           Matrix_1.7-1             
## [17] data.table_1.17.0         homologene_1.4.68.19.3.27
## [19] ggplotify_0.1.2           desc_1.4.3               
## [21] lifecycle_1.0.4           farver_2.1.2             
## [23] compiler_4.4.2            treeio_1.30.0            
## [25] textshaping_0.4.1         munsell_0.5.1            
## [27] carData_3.0-5             ggtree_3.14.0            
## [29] gprofiler2_0.2.3          ggfun_0.1.8              
## [31] htmltools_0.5.8.1         sass_0.4.9               
## [33] yaml_2.3.10               lazyeval_0.2.2           
## [35] plotly_4.10.4             Formula_1.2-5            
## [37] pillar_1.10.1             pkgdown_2.1.1            
## [39] car_3.1-3                 ggpubr_0.6.0             
## [41] jquerylib_0.1.4           tidyr_1.3.1              
## [43] cachem_1.1.0              grr_0.9.5                
## [45] abind_1.4-8               nlme_3.1-166             
## [47] tidyselect_1.2.1          aplot_0.2.5              
## [49] digest_0.6.37             dplyr_1.1.4              
## [51] purrr_1.0.4               bookdown_0.42            
## [53] fastmap_1.2.0             grid_4.4.2               
## [55] colorspace_2.1-1          cli_3.6.4                
## [57] magrittr_2.0.3            patchwork_1.3.0          
## [59] broom_1.0.7               ape_5.8-1                
## [61] scales_1.3.0              backports_1.5.0          
## [63] httr_1.4.7                rmarkdown_2.29           
## [65] ggsignif_0.6.4            ragg_1.3.3               
## [67] evaluate_1.0.3            knitr_1.49               
## [69] viridisLite_0.4.2         gridGraphics_0.5-1       
## [71] rlang_1.1.5               Rcpp_1.0.14              
## [73] glue_1.8.0                tidytree_0.4.6           
## [75] BiocManager_1.30.25       jsonlite_1.9.1           
## [77] R6_2.6.1                  systemfonts_1.1.0        
## [79] fs_1.6.5