\HeaderA{warning}{Warning Messages}{warning}
\aliasA{suppressWarnings}{warning}{suppressWarnings}
\keyword{programming}{warning}
\keyword{error}{warning}
\begin{Description}\relax
Generates a warning message that corresponds to its argument(s) and
(optionally) the expression or function from which it was called.
\end{Description}
\begin{Usage}
\begin{verbatim}
warning(..., call. = TRUE, immediate. = FALSE, domain = NULL)
suppressWarnings(expr)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{...}] zero or more objects which can be coerced to character
(and which are pasted together with no separator) or a single
condition object.
\item[\code{call.}] logical, indicating if the call should become part of the
warning message.
\item[\code{immediate.}] logical, indicating if the call should be output
immediately, even if \code{\LinkA{getOption}{getOption}(warn) <= 0}.
\item[\code{expr}] expression to evaluate.
\item[\code{domain}] see \code{\LinkA{gettext}{gettext}}. If \code{NA}, messages will
not be translated.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
The result \emph{depends} on the value of
\code{\LinkA{options}{options}("warn")} and on handlers established in the
executing code.

If a condition object is supplied it should be the only argument, and
further arguments will be ignored, with a message.

\code{warning} signals a warning condition by (effectively) calling
\code{signalCondition}.  If there are no handlers or if all handlers
return, then the value of \code{warn = \LinkA{getOption}{getOption}("warn")} is
used to determine the appropriate action.  If \code{warn} is negative
warnings are ignored; if it is zero they are stored and printed after
the top--level function has completed; if it is one they are printed
as they occur and if it is 2 (or larger) warnings are turned into
errors. Calling \code{warning(immediate. = TRUE)} turns \code{warn <=
    0} into \code{warn = 1} for this call only.


If \code{warn} is zero (the default), a read-only variable
\code{last.warning} is created.  It contains the warnings which can be
printed via a call to \code{\LinkA{warnings}{warnings}}.

Warnings will be truncated to \code{\LinkA{getOption}{getOption}("warning.length")}
characters, default 1000, indicated by \code{[... truncated]}.

While the warning is being processed, a \code{muffleWarning} restart
is available.  If this restart is invoked with \code{invokeRestart},
then \code{warning} returns immediately.

An attempt is made to coerce other types of inputs to \code{warning}
to character vectors.

\code{suppressWarnings} evaluates its expression in a context that
ignores all warnings.
\end{Details}
\begin{References}\relax
Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988)
\emph{The New S Language}.
Wadsworth \& Brooks/Cole.
\end{References}
\begin{SeeAlso}\relax
\code{\LinkA{stop}{stop}} for fatal errors,
\code{\LinkA{message}{message}} for diagnostic messages,
\code{\LinkA{warnings}{warnings}},
and \code{\LinkA{options}{options}} with argument \code{warn=}.

\code{\LinkA{gettext}{gettext}} for the mechanisms for the automated translation
of messages.
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}

testit <- function() warning("testit")
testit() ## shows call
testit <- function() warning("problem in testit", call. = FALSE)
testit() ## no call
suppressWarnings(warning("testit"))

\end{ExampleCode}
\end{Examples}

