Docker/Singularity Containers

DockerHub

epicompare is now available via DockerHub as a containerised environment with Rstudio and all necessary dependencies pre-installed.

Installation

Method 1: via Docker

First, install Docker if you have not already.

Create an image of the Docker container in command line:

docker pull neurogenomicslab/epicompare

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 8787:8787 \
  neurogenomicslab/epicompare

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://neurogenomicslab/epicompare

Usage

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

Login using the credentials set during the Installation steps.

Session Info

utils::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:   /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] EpiCompare_1.11.0 BiocStyle_2.35.0 
## 
## loaded via a namespace (and not attached):
##   [1] splines_4.4.1                          
##   [2] BiocIO_1.17.0                          
##   [3] bitops_1.0-9                           
##   [4] ggplotify_0.1.2                        
##   [5] filelock_1.0.3                         
##   [6] tibble_3.2.1                           
##   [7] R.oo_1.26.0                            
##   [8] XML_3.99-0.17                          
##   [9] lifecycle_1.0.4                        
##  [10] lattice_0.22-6                         
##  [11] magrittr_2.0.3                         
##  [12] plotly_4.10.4                          
##  [13] sass_0.4.9                             
##  [14] rmarkdown_2.28                         
##  [15] jquerylib_0.1.4                        
##  [16] yaml_2.3.10                            
##  [17] plotrix_3.8-4                          
##  [18] ggtangle_0.0.3                         
##  [19] cowplot_1.1.3                          
##  [20] DBI_1.2.3                              
##  [21] buildtools_1.0.0                       
##  [22] RColorBrewer_1.1-3                     
##  [23] lubridate_1.9.3                        
##  [24] abind_1.4-8                            
##  [25] zlibbioc_1.51.2                        
##  [26] GenomicRanges_1.57.2                   
##  [27] purrr_1.0.2                            
##  [28] R.utils_2.12.3                         
##  [29] BiocGenerics_0.53.0                    
##  [30] RCurl_1.98-1.16                        
##  [31] yulab.utils_0.1.7                      
##  [32] rappdirs_0.3.3                         
##  [33] GenomeInfoDbData_1.2.13                
##  [34] IRanges_2.39.2                         
##  [35] S4Vectors_0.43.2                       
##  [36] enrichplot_1.25.5                      
##  [37] ggrepel_0.9.6                          
##  [38] tidytree_0.4.6                         
##  [39] maketools_1.3.1                        
##  [40] ChIPseeker_1.43.0                      
##  [41] codetools_0.2-20                       
##  [42] DelayedArray_0.31.14                   
##  [43] DOSE_3.99.1                            
##  [44] tidyselect_1.2.1                       
##  [45] aplot_0.2.3                            
##  [46] UCSC.utils_1.1.0                       
##  [47] farver_2.1.2                           
##  [48] matrixStats_1.4.1                      
##  [49] stats4_4.4.1                           
##  [50] BiocFileCache_2.15.0                   
##  [51] GenomicAlignments_1.41.0               
##  [52] jsonlite_1.8.9                         
##  [53] tools_4.4.1                            
##  [54] treeio_1.29.2                          
##  [55] TxDb.Hsapiens.UCSC.hg19.knownGene_3.2.2
##  [56] Rcpp_1.0.13                            
##  [57] glue_1.8.0                             
##  [58] SparseArray_1.5.45                     
##  [59] xfun_0.48                              
##  [60] qvalue_2.37.0                          
##  [61] MatrixGenerics_1.17.1                  
##  [62] GenomeInfoDb_1.41.2                    
##  [63] dplyr_1.1.4                            
##  [64] withr_3.0.2                            
##  [65] BiocManager_1.30.25                    
##  [66] fastmap_1.2.0                          
##  [67] boot_1.3-31                            
##  [68] fansi_1.0.6                            
##  [69] caTools_1.18.3                         
##  [70] digest_0.6.37                          
##  [71] timechange_0.3.0                       
##  [72] R6_2.5.1                               
##  [73] mime_0.12                              
##  [74] gridGraphics_0.5-1                     
##  [75] seqPattern_1.37.0                      
##  [76] colorspace_2.1-1                       
##  [77] GO.db_3.20.0                           
##  [78] gtools_3.9.5                           
##  [79] RSQLite_2.3.7                          
##  [80] R.methodsS3_1.8.2                      
##  [81] b64_0.1.3                              
##  [82] utf8_1.2.4                             
##  [83] tidyr_1.3.1                            
##  [84] generics_0.1.3                         
##  [85] data.table_1.16.2                      
##  [86] rtracklayer_1.65.0                     
##  [87] bsplus_0.1.4                           
##  [88] httr_1.4.7                             
##  [89] htmlwidgets_1.6.4                      
##  [90] S4Arrays_1.5.11                        
##  [91] downloadthis_0.4.1                     
##  [92] pkgconfig_2.0.3                        
##  [93] gtable_0.3.6                           
##  [94] blob_1.2.4                             
##  [95] impute_1.79.0                          
##  [96] XVector_0.45.0                         
##  [97] sys_3.4.3                              
##  [98] htmltools_0.5.8.1                      
##  [99] fgsea_1.31.6                           
## [100] scales_1.3.0                           
## [101] Biobase_2.67.0                         
## [102] png_0.1-8                              
## [103] ggfun_0.1.7                            
## [104] knitr_1.48                             
## [105] tzdb_0.4.0                             
## [106] reshape2_1.4.4                         
## [107] rjson_0.2.23                           
## [108] nlme_3.1-166                           
## [109] curl_5.2.3                             
## [110] cachem_1.1.0                           
## [111] stringr_1.5.1                          
## [112] BiocVersion_3.21.1                     
## [113] KernSmooth_2.23-24                     
## [114] parallel_4.4.1                         
## [115] AnnotationDbi_1.69.0                   
## [116] restfulr_0.0.15                        
## [117] pillar_1.9.0                           
## [118] grid_4.4.1                             
## [119] vctrs_0.6.5                            
## [120] gplots_3.2.0                           
## [121] dbplyr_2.5.0                           
## [122] evaluate_1.0.1                         
## [123] readr_2.1.5                            
## [124] GenomicFeatures_1.57.1                 
## [125] cli_3.6.3                              
## [126] compiler_4.4.1                         
## [127] Rsamtools_2.21.2                       
## [128] rlang_1.1.4                            
## [129] crayon_1.5.3                           
## [130] labeling_0.4.3                         
## [131] plyr_1.8.9                             
## [132] fs_1.6.4                               
## [133] stringi_1.8.4                          
## [134] genomation_1.37.0                      
## [135] viridisLite_0.4.2                      
## [136] gridBase_0.4-7                         
## [137] BiocParallel_1.41.0                    
## [138] munsell_0.5.1                          
## [139] Biostrings_2.75.0                      
## [140] lazyeval_0.2.2                         
## [141] GOSemSim_2.31.2                        
## [142] Matrix_1.7-1                           
## [143] BSgenome_1.75.0                        
## [144] hms_1.1.3                              
## [145] patchwork_1.3.0                        
## [146] bit64_4.5.2                            
## [147] ggplot2_3.5.1                          
## [148] KEGGREST_1.45.1                        
## [149] SummarizedExperiment_1.35.5            
## [150] highr_0.11                             
## [151] AnnotationHub_3.15.0                   
## [152] igraph_2.1.1                           
## [153] memoise_2.0.1                          
## [154] bslib_0.8.0                            
## [155] ggtree_3.13.2                          
## [156] fastmatch_1.1-4                        
## [157] bit_4.5.0                              
## [158] ape_5.8