postponeAction: Postponing Actions

In pkgmaker: Development Utilities for R Packages

Postponing Actions

Description

This function implement a mechanism to postpone actions, which can be executed at a later stage. This is useful when developing packages, where actions that need to be run in the link{.onLoad} function but can be defined close to their context.

Usage

postponeAction(
  expr,
  key = digest(tempfile()),
  group = NULL,
  envir = topns(strict = FALSE),
  verbose = getOption("actions.verbose", getOption("verbose"))
)

runPostponedAction(
  group = NULL,
  verbose = getOption("actions.verbose", getOption("verbose"))
)

Arguments

expr	expression that define the action to postpone. Currently only functions are supported.
key	identifier for this specific action. It should be unique across the postponed actions from the same group.
group	optional parent action group. This enables to define meaningful sets of actions that can be run all at once.
envir	environment in which the action should be executed. Currently not used.
verbose	logical that toggles verbose messages.

Value

postponeAction returns the names of the postponed actions.

Examples

opt <- options(actions.verbose=2)

# define actions
postponeAction(function(){print(10)}, "print")
postponeAction(function(){print(1:10)}, "more")
postponeAction()
# execute actions
runPostponedAction()
runPostponedAction()

# restore options
options(opt)

pkgmaker documentation built on May 3, 2023, 5:08 p.m.