R.utils (version 2.0.2)

onGarbageCollect: Registers a function to be called when the R garbage collector is (detected to be) running

Description

Registers a function to be called when the R garbage collector is (detected to be) running.

Usage

## S3 method for class 'default':
onGarbageCollect(fcn, action=c("prepend", "append", "replace"), ...)

Arguments

fcn

A function to be called without argument.

action

A character string specifying how the hook function is added to list of hooks.

...

Not used.

Value

• Returns (invisibly) the hooks successfully called.

Examples

onGarbageCollect(function(...) {
    message("The R garbage collector is running!");
  })