readImmediateConditions: Writes and Reads 'immediateCondition' RDS Files

In HenrikBengtsson/future: Unified Parallel and Distributed Processing in R for Everyone

Writes and Reads 'immediateCondition' RDS Files

Description

Writes and Reads 'immediateCondition' RDS Files

Usage

readImmediateConditions(
  path = immediateConditionsPath(rootPath = rootPath),
  rootPath = tempdir(),
  pattern = "[.]rds$",
  include = getOption("future.relay.immediate", "immediateCondition"),
  signal = FALSE,
  remove = TRUE
)

saveImmediateCondition(
  cond,
  path = immediateConditionsPath(rootPath = rootPath),
  rootPath = tempdir()
)

Arguments

path	(character string) The folder where the RDS files are.
pattern	(character string) A regular expression selecting the RDS files to be read.
include	(character vector) The class or classes of the objects to be kept.
signal	(logical) If TRUE, the condition read are signaled.
remove	(logical) If TRUE, the RDS files used are removed on exit.
cond	A condition of class immediateCondition.

Value

readImmediateConditions() returns a base::list of immediateCondition objects.

saveImmediateCondition() returns, invisibly, the pathname of the RDS written.

HenrikBengtsson/future documentation built on Dec. 15, 2024, 8:42 p.m.