File: throw.default.R

package info (click to toggle)
r-cran-r.methodss3 1.8.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 300 kB
  • sloc: sh: 12; makefile: 2
file content (42 lines) | stat: -rw-r--r-- 1,258 bytes parent folder | download
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
###########################################################################/**
# @RdocDefault throw
#
# @title "Throws an exception"
#
# \description{
#  Throws an exception by calling stop().
#
#  Note that \code{throw()} can be defined for specific classes, which can
#  then be caught (or not) using \code{\link[base:conditions]{tryCatch}}().
#
#  \emph{This default function will be overridden by ditto in the \bold{R.oo}
#  package, if that is loaded.  The latter \code{R.oo::throw()} implementation
#  is fully backward compatible with this one, but the error object thrown
#  is of class \code{R.oo::Exception}.}
#
#  \emph{WARNING: This function is deprecated in favor of \code{R.oo::throw()},
#  or alternatively, just \code{stop()}.}
# }
#
# @synopsis
#
# \arguments{
#   \item{...}{One or several strings that are concatenated and collapsed
#       into on message string.}
# }
#
# \value{
#   Returns nothing.
# }
#
# @examples "../incl/throw.Rex"
#
# @author
#
# \keyword{error}
# \keyword{internal}
#*/###########################################################################
setMethodS3("throw", "default", function(...) {
  .Deprecated(msg = "R.methodsS3::throw() is deprecated. Use base::stop() instead, or R.oo::throw().")
  stop(...)
})