R/package.check.R

In ImmuneDynamics/Spectre: High-dimensional cytometry and imaging analysis

#' package.check - a function to check the installation of all required packages.
#'
#' This function allows you to check to see if all the common use packages dependencies for Spectre are installed.
#' See \url{https://sydneycytometry.org.au/spectre} for usage instructions and vignettes.
#'
#' @return returns an error message if one of the common use packages are not installed. Proceeds in order of package importance, and only the first error message encountered will be returned.
#'
#' @param type DEFAULT = "general". If "general", then checks for the packages required for general Spectre usage. If "spatial", then checks for additional packages required for spatial analysis. If "ML", then checks for additional packages required for machine-learing functionality.
#'
#' @author Thomas M Ashhurst, \email{thomas.ashhurst@@sydney.edu.au}
#'
#' @references \url{https://sydneycytometry.org.au/spectre}
#'
#' 
#'
#' @examples
#' package.check()
#'
#' @export

package.check <- function(type = "general"){
  
    deets <- utils::packageDescription('spectre')
    os.deets <- utils::sessionInfo()
    r.deets <- R.Version()
    
    message(paste0('Package: ', deets$Package))
    message(paste0(' -- Version:           ', deets$Version))
    message(paste0(' -- Install date:      ', deets$Packaged))
    message(paste0(' -- Install source:    ', deets$RemoteType))
    message(paste0(' -- R version:         ', r.deets$version.string))
    message(paste0(' -- OS:                ', os.deets$running))
    message(paste0(' -- OS detail:         ', os.deets$platform))
    message(' -- Library path(s):      ')
    
    for(i in .libPaths()){
      message(paste0('        ', i))
    }

    message(paste0('               '))
    
    # if(deets$ondiskversion != deets$loadedversion){
    #   message(paste0("Please note, your 'on disk' version of Spectre is different to the 'loaded' version (i.e. you appear to have had the Spectre library loaded and active while installing a new version. To address this, either:"))
    #   message(paste0("    a) run 'detach('package:Spectre', unload = TRUE)' followed by 'library('Spectre'), or"))
    #   message(paste0("    b) re-start RStudio"))
    #   message('   ')
    # }
    
    message(paste0(('Checking dependency packages...')))
    
    res.list <- list()
  
    if(!is.element('colorRamps', installed.packages()[,1])){
      message(' -- colorRamps is required but not installed')
      res.list[['colorRamps']] <- 'colorRamps'
    } 
    
    if(!is.element('data.table', installed.packages()[,1])){
      message(' -- data.table is required but not installed')
      res.list[['data.table']] <- 'data.table'
    } 
    
    if(!is.element('dendsort', installed.packages()[,1])){
      message(' -- dendsort is required but not installed')
      res.list[['dendsort']] <- 'dendsort'
    } 
    
    if(!is.element('factoextra', installed.packages()[,1])){
      message(' -- factoextra is required but not installed')
      res.list[['factoextra']] <- 'factoextra'
    } 
    
    if(!is.element('flowCore', installed.packages()[,1])){
      message(' -- flowCore is required but not installed')
      res.list[['flowCore']] <- 'flowCore'
    } 
    
    if(!is.element('FlowSOM', installed.packages()[,1])){
      message(' -- FlowSOM is required but not installed')
      res.list[['FlowSOM']] <- 'FlowSOM'
    } 
    
    if(!is.element('ggplot2', installed.packages()[,1])){
      message(' -- ggplot2 is required but not installed')
      res.list[['ggplot2']] <- 'ggplot2'
    } 
    
    if(!is.element('ggpointdensity', installed.packages()[,1])){
      message(' -- ggpointdensity is required but not installed')
      res.list[['ggpointdensity']] <- 'ggpointdensity'
    } 
    
    if(!is.element('ggpubr', installed.packages()[,1])){
      message(' -- ggpubr is required but not installed')
      res.list[['ggpubr']] <- 'ggpubr'
    } 
    
    if(!is.element('ggthemes', installed.packages()[,1])){
      message(' -- ggthemes is required but not installed')
      res.list[['ggthemes']] <- 'ggthemes'
    } 
    
    if(!is.element('gridExtra', installed.packages()[,1])){
      message(' -- gridExtra is required but not installed')
      res.list[['gridExtra']] <- 'gridExtra'
    } 
    
    if(!is.element('gtools', installed.packages()[,1])){
      message(' -- gtools is required but not installed')
      res.list[['gtools']] <- 'gtools'
    } 
    
    if(!is.element('irlba', installed.packages()[,1])){
      message(' --  irlba is required but not installed')
      res.list[['irlba']] <- 'irlba'
    } 
    
    if(!is.element('parallel', installed.packages()[,1])){
      message(' -- parallel is required but not installed')
      res.list[['parallel']] <- 'parallel'
    } 
    
    if(!is.element('pheatmap', installed.packages()[,1])){
      message(' -- pheatmap is required but not installed')
      res.list[['pheatmap']] <- 'pheatmap'
    } 
    
    if(!is.element('RColorBrewer', installed.packages()[,1])){
      message(' -- RColorBrewer is required but not installed')
      res.list[['RColorBrewer']] <- 'RColorBrewer'
    } 
    
    if(!is.element('rstudioapi', installed.packages()[,1])){
      message(' -- rstudioapi is required but not installed')
      res.list[['rstudioapi']] <- 'rstudioapi'
    } 
    
    if(!is.element('rsvd', installed.packages()[,1])){
      message(' -- rsvd is required but not installed')
      res.list[['rsvd']] <- 'rsvd'
    } 
    
    if(!is.element('Rtsne', installed.packages()[,1])){
      message(' -- Rtsne is required but not installed')
      res.list[['']] <- 'Rtsne'
    } 
    
    if(!is.element('scales', installed.packages()[,1])){
      message(' -- scales is required but not installed')
      res.list[['scales']] <- 'scales'
    } 
    
    if(!is.element('scattermore', installed.packages()[,1])){
      message(' -- scattermore is required but not installed')
      res.list[['scattermore']] <- 'scattermore'
    } 
    
    if(!is.element('umap', installed.packages()[,1])){
      message(' -- umap is required but not installed')
      res.list[['umap']] <- 'umap'
    } 
    
    if(!is.element('uwot', installed.packages()[,1])){
      message(' -- uwot is required but not installed')
      res.list[['uwot']] <- 'uwot'
    } 
    
    if(!is.element('viridis', installed.packages()[,1])){
      message(' -- viridis is required but not installed')
      res.list[['viridis']] <- 'viridis'
    } 


  if(type == "spatial"){
    if(!is.element('raster', installed.packages()[,1])) {
      message(' -- raster is required for SPATIAL analysis but is not installed')
      res.list[['raster']] <- 'raster'
    } 
    
    if(!is.element('tiff', installed.packages()[,1])) {
      message(' -- tiff is required for SPATIAL analysis but is not installed')
      res.list[['tiff']] <- 'tiff'
    } 
    
    if(!is.element('exactextractr', installed.packages()[,1])) {
      message(' -- exactextractr is required for SPATIAL analysis but is not installed')
      res.list[['exactextractr']] <- 'exactextractr'
    } 
    
    if(!is.element('sp', installed.packages()[,1])) {
      message(' -- sp is required for SPATIAL analysis but is not installed')
      res.list[['sp']] <- 'sp'
    } 
    
    if(!is.element('sf', installed.packages()[,1])) {
      message(' -- sf is required for SPATIAL analysis but is not installed')
      res.list[['sf']] <- 'sf'
    } 
    
    if(!is.element('stars', installed.packages()[,1])) {
      message(' -- stars is required for SPATIAL analysis but is not installed')
      res.list[['stars']] <- 'stars'
    } 
    
    if(!is.element('qs', installed.packages()[,1])) {
      message(' -- qs is required for SPATIAL analysis but is not installed')
      res.list[['qs']] <- 'qs'
    } 
    
    if(!is.element('s2', installed.packages()[,1])) {
      message(' -- s2 is required for SPATIAL analysis but is not installed')
      res.list[['s2']] <- 's2'
    } 
    
    if(!is.element('rhdf5', installed.packages()[,1])) {
      message(' -- rhdf5 is required for SPATIAL analysis but is not installed')
      res.list[['rhdf5']] <- 'rhdf5'
    } 

  }
  
  ### Final message
    
    if(length(res.list) > 0){
      message(paste0('               '))
      message(paste0('Check out ', "'https://immunedynamics.github.io/spectre/getting-started/'", ' for help with installation'))
    }
    
    if(length(res.list) == 0){
      message(" -- All packages successfully installed.")
      message(paste0('               '))
      message(paste0('Check out ', "'https://immunedynamics.github.io/spectre/'", ' for protocols'))
    }

}