Run All or a Subset of the Tests Across Future Plans

  plan = NULL,
  tags = character(),
  timeout = NULL,
  settings = TRUE,
  session_info = FALSE,
  debug = FALSE,
  exit_value = !interactive(),
  .args = commandArgs()



(character vector) One or more future strategy plans to be validated.


(character vector; optional) Filter test by tags. If NULL, all tests are performed.


(numeric; optional) Maximum time (in seconds) each test may run before a timeout error is produced.


(logical) If TRUE, details on the settings are outputted before the tests start.


(logical) If TRUE, session information is outputted after the tests complete.


(logical) If TRUE, the raw test results are printed.


(logical) If TRUE, and in a non-interactive session, then use base::quit() to quit R with an exit code of 0 (zero) if all tests passed with all OKs and otherwise 1 (one) if one or more test failed.


(character vector; optional) Command-line arguments.


(list; invisible) A list of test results.

Command-line interface (CLI)

This function can be called from the shell. To specify an argument, use the format --test-<arg_name>=<value>. For example, --test-timeout=600 will set argument timeout=600, and --tags=lazy,rng, or equivalently, --tags=lazy --tags=rng will set argument tags=c("lazy", "rng").

Here are some examples on how to call this function from the command line:

Rscript -e future.tests::check --args --test-plan=sequential
Rscript -e future.tests::check --args --test-plan=multicore,workers=2
Rscript -e future.tests::check --args --test-plan=sequential --test-plan=multicore,workers=2

The exit code will be 0 if all tests passed, otherwise 1. You can use for instance exit_code=$? to retrieve the exit code of the most recent call.


if (FALSE) {
results <- future.tests::check(plan = "sequential", tags = c("rng"))
exit_code <- attr(results, "exit_code")
if (exit_code != 0) stop("One or more tests failed")