R.utils (version 1.5.0)

onSessionExit: Registers a function to be called when the R session finishes

Description

Registers a function to be called when the R session finishes.

Usage

## S3 method for class 'default':
onSessionExit(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.

Details

Functions registered this way are called when finalizeSession() is called. Moreover, when this package is loaded, the .Last() function is modified such that finalizeSession() is called. However, note that .Last() is not guaranteed to be called when the Rsession finished. For instance, the user may quit Rby calling quit(callLast=FALSE). Moreover, when Ris run in batch mode, .Last() is never called.

See Also

.Last(). finalizeSession().

Examples

onSessionExit(function(...) {
    cat("Bye bye world!\n");
  })

  quit()