Compare e26de2a ... +6 ... 3dcc427

#' Benchmark in parallel

#' This function runs benchmarks in parallel to test multithreading

#' @param bm character name of benchmark function to run from \code{\link{get_available_benchmarks}}

#' @param runs number of runs of benchmark to make

#' @param verbose display messages during benchmarking

#' @param ... additional arguments to pass to \code{bm}

#' @import parallel

#' @import foreach

#' @import doParallel

#' @export

#' \dontrun{

#' bm_parallel("bm_matrix_cal_manip", runs = 3, verbose = TRUE, cores = 2)

#'        "bm_matrix_cal_cross_product", "bm_matrix_cal_lm")

#'                 runs = 5, verbose = TRUE, cores = 2L)

#' }

#' @importFrom foreach foreach %dopar%

bm_parallel = function(bm, runs, verbose, cores, ...) {

  #TODO consider dropping first results from parallel results due to overhead

    }

  }

}

benchmarkmeData::is_blas_optimize

#' Benchmark rankings

#' Comparison with past results.

#' @inheritParams upload_results

#' @inheritParams benchmark_std

#' @import dplyr

#' @export

rank_results = function(results,

                        verbose = TRUE) {

#' R version

#' Returns \code{unclass(R.version)}

#' @export

}

#' Get the amount of RAM

#' specific:

#' \itemize{

#' \item Linux: \code{proc/meminfo}

#' \item Apple: \code{system_profiler -detailLevel mini}

#' \item Solaris: \code{prtconf}

#' }

#' A value of \code{NA} is return if it isn't possible to determine the amount of RAM.

#' @export

#' @references The \code{print.bytes} function was taken from the \pkg{pryr} package.

#' ## Return (and pretty print) the amount of RAM

#' get_ram()

get_ram = function() {

  } else {

            Please raise an issue at https://github.com/csgillespie/benchmarkme") # nocov

      ram = structure(NA, class = "ram") #nocov

    } else {

#' @rawNamespace S3method(print,ram)

print.ram = function(x, digits = 3, unit_system = c("metric", "iec"), ...) {

  }

#' Run standard benchmarks

#' @description This function runs a set of standard benchmarks, which should be suitable for most

#' machines. It runs a collection of matrix benchmark functions

#' \itemize{

#' @param runs Number of times to run the test. Default 3.

#' @param cores Default 0 (serial). When cores > 0, the benchmark is run in parallel.

#' @param verbose Default TRUE.

#' @export

#' ## Benchmark your system

#' \dontrun{

#' res = benchmark_std(3)

#' ## Plot results

#' plot(res)

#' }

benchmark_std = function(runs = 3, verbose = TRUE, cores = 0L) {

}