# Docker/Singularity Containers

# 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.5.2 (2025-10-31)
    ## 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=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: Etc/UTC
    ## tzcode source: system (glibc)
    ##
    ## attached base packages:
    ## [1] stats     graphics  grDevices utils     datasets  methods   base
    ##
    ## other attached packages:
    ## [1] orthogene_1.17.2 BiocStyle_2.39.0
    ##
    ## loaded via a namespace (and not attached):
    ##  [1] gtable_0.3.6              babelgene_22.9
    ##  [3] xfun_0.55                 bslib_0.9.0
    ##  [5] ggplot2_4.0.1             htmlwidgets_1.6.4
    ##  [7] rstatix_0.7.3             lattice_0.22-7
    ##  [9] vctrs_0.6.5               tools_4.5.2
    ## [11] generics_0.1.4            yulab.utils_0.2.3
    ## [13] parallel_4.5.2            tibble_3.3.0
    ## [15] pkgconfig_2.0.3           Matrix_1.7-4
    ## [17] data.table_1.18.0         homologene_1.4.68.19.3.27
    ## [19] ggplotify_0.1.3           RColorBrewer_1.1-3
    ## [21] S7_0.2.1                  lifecycle_1.0.4
    ## [23] compiler_4.5.2            farver_2.1.2
    ## [25] treeio_1.35.0             carData_3.0-5
    ## [27] ggtree_4.1.1              gprofiler2_0.2.4
    ## [29] fontLiberation_0.1.0      fontquiver_0.2.1
    ## [31] ggfun_0.2.0               htmltools_0.5.9
    ## [33] sys_3.4.3                 buildtools_1.0.0
    ## [35] sass_0.4.10               yaml_2.3.12
    ## [37] lazyeval_0.2.2            plotly_4.11.0
    ## [39] Formula_1.2-5             pillar_1.11.1
    ## [41] car_3.1-3                 ggpubr_0.6.2
    ## [43] jquerylib_0.1.4           tidyr_1.3.2
    ## [45] cachem_1.1.0              abind_1.4-8
    ## [47] fontBitstreamVera_0.1.1   nlme_3.1-168
    ## [49] tidyselect_1.2.1          aplot_0.2.9
    ## [51] digest_0.6.39             dplyr_1.1.4
    ## [53] purrr_1.2.0               maketools_1.3.2
    ## [55] fastmap_1.2.0             grid_4.5.2
    ## [57] cli_3.6.5                 magrittr_2.0.4
    ## [59] patchwork_1.3.2           broom_1.0.11
    ## [61] ape_5.8-1                 gdtools_0.4.4
    ## [63] scales_1.4.0              backports_1.5.0
    ## [65] rappdirs_0.3.3            httr_1.4.7
    ## [67] rmarkdown_2.30            otel_0.2.0
    ## [69] ggsignif_0.6.4            evaluate_1.0.5
    ## [71] knitr_1.51                viridisLite_0.4.2
    ## [73] gridGraphics_0.5-1        rlang_1.1.6
    ## [75] ggiraph_0.9.2             Rcpp_1.1.0.8.2
    ## [77] glue_1.8.0                tidytree_0.4.6
    ## [79] BiocManager_1.30.27       jsonlite_2.0.0
    ## [81] R6_2.6.1                  systemfonts_1.3.1
    ## [83] fs_1.6.6