use_eddy: Convenience function that creates a new eddy or re-uses it if...

Description Usage Arguments Value See Also Examples

View source: R/eddy-functions.R

Description

Convenience function that creates a new eddy or re-uses it if present

Usage

1
2
3
use_eddy(eddy_name, cache = default_cache(),
  flow_options = default_flow_options(), reuse_if_present = TRUE,
  set_current = TRUE, eddy_env = default_eddy_env())

Arguments

eddy_name

Unique name for the eddy to allow retrieving later.

cache

A cache object returned by one of the cache functions.

flow_options

Options to store for future flow invocations. They do not affect the eddy, they are only stored for ease of access.

reuse_if_present

Logical, whether or not to reuse an eddy with the same name, if already present, even if the flow_options are different.

set_current

Logical, whether to make this eddy current.

eddy_env

The environment in which the eddy is put (bound).

Value

An eddy object to be used for storing flows.

See Also

Other eddy functions: delete_eddy, get_current_eddy, get_eddy, new_eddy, set_current_eddy

Examples

1
use_eddy("use_eddy")

numeract/rflow documentation built on May 28, 2019, 3:39 p.m.