Package 'doFuture.tests.extra'

Title: Extra Test Sets for the 'doFuture' Package
Description: Runs examples of packages that use 'foreach' and '%dopar%' for parallelization, where 'doFuture' is used as the 'foreach' adapter making it possible to use any future backend for parallelization. The package tests use these tools to test 'doFuture' with 'foreach'-based examples from packages 'BiocParallel', 'caret', 'doParallel', 'glmnet', 'NMF', 'plyr', and 'TSP'. These tests are run with many known future backends.
Authors: Henrik Bengtsson [aut, cre, cph]
Maintainer: Henrik Bengtsson <[email protected]>
License: LGPL (>= 2.1)
Version: 0.1.1
Built: 2024-10-22 03:46:24 UTC
Source: https://github.com/HenrikBengtsson/doFuture.tests.extra

Help Index

Run All Examples of the 'caret' Package via Futureverse

Description

Run All Examples of the 'caret' Package via Futureverse

Usage

caret_examples(exclude = NULL)

Arguments

exclude

(optional) A character vector of Rd topics to exclude.

Run All Examples of the 'foreach' Package via Futureverse

Description

Run All Examples of the 'foreach' Package via Futureverse

Usage

foreach_examples()

Run All Examples of the 'glmnet' Package via Futureverse

Description

Run All Examples of the 'glmnet' Package via Futureverse

Usage

glmnet_examples()

Run All Examples of the 'plyr' Package via Futureverse

Description

Run All Examples of the 'plyr' Package via Futureverse

Usage

plyr_examples()

Run one package example

Description

Run one package example

Usage

run_example(
  topic,
  package,
  local = FALSE,
  run.dontrun = TRUE,
  envir = globalenv()
)

Arguments

topic

name or literal character string: the online help topic the examples of which should be run.
package

a character vector giving the package names to look into for the topic, or NULL (the default), when all packages on the search path are used.
local

logical: if TRUE evaluate locally, if FALSE evaluate in the workspace.
run.dontrun

logical indicating that ⁠\dontrun⁠ should be ignored.
envir

The environment from which variables created by the examples should be removed at the end.

Value

Invisibly, returns the processing time.

See Also

utils::example() is used to run the select example.

Run a package's examples for a specific future plan

Description

Run a package's examples for a specific future plan

Usage

run_examples(package, topics = test_topics(package), strategy, ...)

Arguments

package

A package name.
topics

One or more Rd topics.
strategy

A future strategy passed to future::plan().
...

Additional arguments passed to run_example().

Value

Invisibly, returns the processing time.

Get Available Future Strategies

Description

Get Available Future Strategies

Usage

test_strategies()

Value

A character vector of future strategies.

Run All Examples of the 'test_topics' Package via Futureverse

Description

Run All Examples of the 'test_topics' Package via Futureverse

Usage

test_topics(package, subset = NA_integer_, max_subset = NULL)

Arguments

package

A package name.
subset

An integer index.
max_subset

An integer or NULL.

Value

Return Rd topics.

Run All Examples of the 'TSP' Package via Futureverse

Description

Run All Examples of the 'TSP' Package via Futureverse

Usage

TSP_examples()