{"Type":"Package","Package":"benchmarkme","Title":"Crowd Sourced System Benchmarks","Version":"1.0.8","Authors@R":"\nperson(\"Colin\", \"Gillespie\", , \"csgillespie@gmail.com\", role = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0003-1787-0275\"))","Maintainer":"Colin Gillespie ","Description":"Benchmark your CPU and compare against other CPUs. Also\nprovides functions for obtaining system specifications, such as RAM,\nCPU type, and R version.","License":"GPL-2 | GPL-3","URL":"https://github.com/csgillespie/benchmarkme","BugReports":"https://github.com/csgillespie/benchmarkme/issues","Depends":"R (>= 3.5.0)","Imports":"benchmarkmeData (>= 1.0.4), compiler, doParallel, dplyr,\nforeach, graphics, httr, Matrix, methods, parallel, stringr,\ntibble, utils","Suggests":"covr, DT, ggplot2, knitr, RcppZiggurat, rmarkdown, testthat","VignetteBuilder":"knitr","Encoding":"UTF-8","LazyData":"TRUE","RoxygenNote":"7.1.2","NeedsCompilation":"no","Packaged":"2022-06-12 14:52:28 UTC; ncsg3","Author":"Colin Gillespie [aut, cre] ()","Repository":"CRAN","Date/Publication":"2022-06-12 15:50:16 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/benchmarkme_1.0.8.tar.gz","jsonAuthors":[{"name":"Colin Gillespie","email":"csgillespie@gmail.com","maintainer":true}],"readme":"\n\n\n# System benchmarking\n\n[![R-CMD-check](https://github.com/csgillespie/benchmarkme/workflows/R-CMD-check/badge.svg)](https://github.com/csgillespie/benchmarkme/actions)\n[![codecov.io](https://codecov.io/github/csgillespie/benchmarkme/coverage.svg?branch=master)](https://codecov.io/github/csgillespie/benchmarkme?branch=master)\n[![Downloads](http://cranlogs.r-pkg.org/badges/benchmarkme?color=brightgreen)](https://cran.r-project.org/package=benchmarkme)\n[![CRAN\\_Status\\_Badge](http://www.r-pkg.org/badges/version/benchmarkme)](https://cran.r-project.org/package=benchmarkme)\n\nR benchmarking made easy. The package contains a number of benchmarks,\nheavily based on the benchmarks at\n, for assessing\nthe speed of your system.\n\nThe package is for R 3.5 and above. In previous versions R, detecting\nthe effect of the byte compiler was tricky and produced unrealistic\ncomparisons.\n\n## Overview\n\nA straightforward way of speeding up your analysis is to buy a better\ncomputer. Modern desktops are relatively cheap, especially compared to\nuser time. However, it isn’t clear if upgrading your computing is worth\nthe cost. The **benchmarkme** package provides a set of benchmarks to\nhelp quantify your system. More importantly, it allows you to compare\nyour timings with *other* systems.\n\n\n\n## Overview\n\nThe package is on [CRAN](https://cran.r-project.org/package=benchmarkme)\nand can be installed in the usual way\n\n``` r\ninstall.packages(\"benchmarkme\")\n```\n\nThere are two groups of benchmarks:\n\n- `benchmark_std()`: this benchmarks numerical operations such as\n loops and matrix operations. The benchmark comprises of three\n separate benchmarks: `prog`, `matrix_fun`, and `matrix_cal`.\n- `benchmark_io()`: this benchmarks reading and writing a 5 / 50, MB\n csv file.\n\n### The benchmark\\_std() function\n\nThis benchmarks numerical operations such as loops and matrix\noperations. This benchmark comprises of three separate benchmarks:\n`prog`, `matrix_fun`, and `matrix_cal`. If you have less than 3GB of RAM\n(run `get_ram()` to find out how much is available on your system), then\nyou should kill any memory hungry applications, e.g. firefox, and set\n`runs = 1` as an argument.\n\nTo benchmark your system, use\n\n``` r\nlibrary(\"benchmarkme\")\n## Increase runs if you have a higher spec machine\nres = benchmark_std(runs = 3)\n```\n\nand upload your results\n\n``` r\n## You can control exactly what is uploaded. See details below.\nupload_results(res)\n```\n\nYou can compare your results to other users via\n\n``` r\nplot(res)\n```\n\n\n\n\n\n\n\n\n### The benchmark\\_io() function\n\nThis function benchmarks reading and writing a 5MB or 50MB (if you have\nless than 4GB of RAM, reduce the number of `runs` to 1). Run the\nbenchmark using\n\n``` r\nres_io = benchmark_io(runs = 3)\nupload_results(res_io)\nplot(res_io)\n```\n\nBy default the files are written to a temporary directory generated\n\n``` r\ntempdir()\n```\n\nwhich depends on the value of\n\n``` r\nSys.getenv(\"TMPDIR\")\n```\n\nYou can alter this to via the `tmpdir` argument. This is useful for\ncomparing hard drive access to a network drive.\n\n``` r\nres_io = benchmark_io(tmpdir = \"some_other_directory\")\n```\n\n### Parallel benchmarks\n\nThe benchmark functions above have a parallel option - just simply\nspecify the number of cores you want to test. For example to test using\nfour cores\n\n``` r\nres_io = benchmark_std(runs = 3, cores = 4)\nplot(res_io)\n```\n\n## Previous versions of the package\n\nThis package was started around 2015. However, multiple changes in the\nbyte compiler over the last few years, has made it very difficult to use\nprevious results. So we have to start from scratch.\n\nThe previous data can be obtained via\n\n``` r\ndata(past_results, package = \"benchmarkmeData\")\n```\n\n## Machine specs\n\nThe package has a few useful functions for extracting system specs:\n\n- RAM: `get_ram()`\n- CPUs: `get_cpu()`\n- BLAS library: `get_linear_algebra()`\n- Is byte compiling enabled: `get_byte_compiler()`\n- General platform info: `get_platform_info()`\n- R version: `get_r_version()`\n\nThe above functions have been tested on a number of systems. If they\ndon’t work on your system, please raise\n[GitHub](https://github.com/csgillespie/benchmarkme/issues) issue.\n\n## Uploaded data sets\n\nA summary of the uploaded data sets is available in the\n[benchmarkmeData](https://github.com/csgillespie/benchmarkme-data)\npackage\n\n``` r\ndata(past_results_v2, package = \"benchmarkmeData\")\n```\n\nA column of this data set, contains the unique identifier returned by\nthe `upload_results()` function.\n\n## What’s uploaded\n\nTwo objects are uploaded:\n\n1. Your benchmarks from `benchmark_std` or `benchmark_io`;\n2. A summary of your system information (`get_sys_details()`).\n\nThe `get_sys_details()` returns:\n\n- `Sys.info()`;\n- `get_platform_info()`;\n- `get_r_version()`;\n- `get_ram()`;\n- `get_cpu()`;\n- `get_byte_compiler()`;\n- `get_linear_algebra()`;\n- `installed.packages()`;\n- `Sys.getlocale()`;\n- The `benchmarkme` version number;\n- Unique ID - used to extract results;\n- The current date.\n\nThe function `Sys.info()` does include the user and nodenames. In the\npublic release of the data, this information will be removed. If you\ndon’t wish to upload certain information, just set the corresponding\nargument, i.e.\n\n``` r\nupload_results(res, args = list(sys_info = FALSE))\n```\n\n------------------------------------------------------------------------\n\nDevelopment of this package was supported by [Jumping\nRivers](https://www.jumpingrivers.com)","jobInfo":{"package":"benchmarkme","version":"1.0.8","parsingStatus":"success","parserVersion":1,"parsedAt":"2022-06-12T18:30:10+0000"}}

Description

Usage

Arguments