pkgmaker: postponeAction – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

postponeAction

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("verbose")
)

runPostponedAction(group = NULL, 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.

Examples

opt <- options(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

Development Utilities for R Packages

v0.32.2

GPL (>= 2)

Authors

Renaud Gaujoux [aut, cre]

Initial release

2020-10-20