R/cleanConda.R

In LTLA/basilisk.utils: Basilisk Installation Utilities

#' Run \code{conda clean}
#'
#' Clean the Conda installation to remove unused packages and tarballs.
#'
#' @param loc String containing the path to the root of a conda instance. 
#'
#' @return An integer value indicating whether the cleaning was successful.
#'
#' @details
#' This should only be performed to save disk space for system installations, 
#' as the cached extras will never be used by any other \pkg{basilisk} package.
#'
#' In contrast, for an externally cached conda, the extras may be re-used by other \pkg{basilisk} clients.
#' So it's usually worth keeping them around, though this function can be called directly by the user if the cache gets too big.
#'
#' @author Aaron Lun
#' 
#' @examples
#' # We can't actually run cleanConda() here, as it 
#' # either relies on basilisk already being installed or
#' # it has a hard-coded path to the basilisk system dir.
#' print("dummy test to pass BiocCheck")
#'
#' @export 
cleanConda <- function(loc=getCondaDir()) {
    listing <- activateEnvironment(loc=loc)
    on.exit(deactivateEnvironment(listing))
    system2(getCondaBinary(loc), c("clean", "-ayq"))
}