R/cpus.R

In acidgenomics/acidbase: Acid Genomics Base Functions

#' Detect the number of CPU cores
#'
#' @export
#' @note Updated 2023-05-16.
#'
#' @return `integer(1)`.
#' Number of CPU cores.
#'
#' @seealso
#' - parallel::detectCores
#' - ps::ps_cpu_count
#'
#' @examples
#' cpus()
cpus <- function() {
    assert(requireNamespaces("parallel"))
    n <- parallel::detectCores(all.tests = FALSE, logical = TRUE)
    assert(is.integer(n))
    n
}