onSessionExit

0th

Percentile

Registers a function to be called when the R session finishes

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

Keywords
programming
Usage
# S3 method for 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.

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 R session finished. For instance, the user may quit R by calling quit(callLast=FALSE). Moreover, when R is run in batch mode, .Last() is never called.

Value

Returns (invisibly) the hooks successfully called.

See Also

.Last(). finalizeSession().

Aliases
  • onSessionExit.default
  • onSessionExit
Examples
# NOT RUN {
  onSessionExit(function(...) {
    message("Bye bye world!")
  })

  quit()
# }
Documentation reproduced from package R.utils, version 2.8.0, License: LGPL (>= 2.1)

Community examples

Looks like there are no examples yet.