Description Usage Arguments Details Value Author(s) See Also Examples
View source: R/returnMessage.R
This function returns a short message, summarising the outcome of the
statistical process, typically optimisation. The message should describe either
the type of the convergence,
or the problem. returnMessage
is a generic function, with methods
for various optimisation algorithms.
1 2 3 4 5 | returnMessage(x, ...)
## S3 method for class 'maxim'
returnMessage(x, ...)
## S3 method for class 'maxLik'
returnMessage(x, ...)
|
x |
object, should orginate from an optimisation problem |
... |
further arguments to other methods |
.
The default methods returns component returnMessage
.
Character string, the message describing the success or failure of the statistical procedure.
Ott Toomet, otoomet@ut.ee
1 2 3 4 5 6 7 8 | ## maximise the exponential bell
f1 <- function(x) exp(-x^2)
a <- maxNR(f1, start=2)
returnMessage(a) # should be success (1 or 2)
## Now try to maximise log() function
f2 <- function(x) log(x)
a <- maxNR(f2, start=2)
returnMessage(a) # should give a failure (4)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.