File: addFinalizerToLast.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (45 lines) | stat: -rw-r--r-- 1,166 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  addFinalizerToLast.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{addFinalizerToLast}
\alias{addFinalizerToLast.default}
\alias{addFinalizerToLast}

\title{Modifies .Last() to call 'finalizeSession()}

\description{
  Modifies .Last() to call 'finalizeSession() \emph{before} calling the default \code{.Last()} function.

  Note that \code{.Last()} is \emph{not} guaranteed to be called when
  the \R session finished.  For instance, the user may quit \R by calling
  \code{quit(runLast=FALSE)} or run R in batch mode.

  Note that this function is called when the R.utils package is loaded.
}

\usage{
\method{addFinalizerToLast}{default}(...)
}

\arguments{
 \item{...}{Not used.}
}

\value{
  Returns (invisibly) \code{\link[base:logical]{TRUE}} if \code{.Last()} was modified,
  otherwise \code{\link[base:logical]{FALSE}}.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link{onSessionExit}}().
}


\keyword{programming}