50 lines
1023 B
Plaintext
50 lines
1023 B
Plaintext
|
\name{gsa.error}
|
||
|
|
\alias{gsa.error}
|
||
|
|
\title{
|
||
|
|
GSA error
|
||
|
|
}
|
||
|
|
\description{
|
||
|
|
Write an error message to standard out with the prefix '[gsalib] Error:', print a traceback, and exit.
|
||
|
|
}
|
||
|
|
\usage{
|
||
|
|
gsa.error(message)
|
||
|
|
}
|
||
|
|
%- maybe also 'usage' for other objects documented here.
|
||
|
|
\arguments{
|
||
|
|
\item{message}{
|
||
|
|
The error message to write.
|
||
|
|
}
|
||
|
|
}
|
||
|
|
\details{
|
||
|
|
%% ~~ If necessary, more details than the description above ~~
|
||
|
|
}
|
||
|
|
\value{
|
||
|
|
%% ~Describe the value returned
|
||
|
|
%% If it is a LIST, use
|
||
|
|
%% \item{comp1 }{Description of 'comp1'}
|
||
|
|
%% \item{comp2 }{Description of 'comp2'}
|
||
|
|
%% ...
|
||
|
|
}
|
||
|
|
\references{
|
||
|
|
%% ~put references to the literature/web site here ~
|
||
|
|
}
|
||
|
|
\author{
|
||
|
|
Kiran Garimella
|
||
|
|
}
|
||
|
|
\note{
|
||
|
|
%% ~~further notes~~
|
||
|
|
}
|
||
|
|
|
||
|
|
%% ~Make other sections like Warning with \section{Warning }{....} ~
|
||
|
|
|
||
|
|
\seealso{
|
||
|
|
%% ~~objects to See Also as \code{\link{help}}, ~~~
|
||
|
|
}
|
||
|
|
\examples{
|
||
|
|
gsa.error("This is a message");
|
||
|
|
}
|
||
|
|
% Add one or more standard keywords, see file 'KEYWORDS' in the
|
||
|
|
% R documentation directory.
|
||
|
|
\keyword{ ~kwd1 }
|
||
|
|
\keyword{ ~kwd2 }% __ONLY ONE__ keyword per line
|