Debian Codegraph @

man/diagnostics.Rd

raw
1 \name{diagnostics}
2 \alias{diagnostics}
3 \alias{diagnostics.default}
4 \title{Print Diagnostic Characteristics of Solvers}
5 \description{
6 Prints several diagnostics of the simulation to the screen, e.g.
7 number of steps taken, the last step size, ...
8 }
9 \usage{
10 diagnostics(obj, ...)
11 \method{diagnostics}{default}(obj, ...)
12 }
13 \arguments{
14 \item{obj}{is an output data structure produced by one of the
15 solver routines.
16 }
17 \item{...}{optional arguments allowing to extend \code{diagnostics}
18 as a generic function.
19 }
20 }
21 \details{
22 Detailed information obout the success of a simulation is printed,
23 if a \code{diagnostics} function exists for a specific solver routine.
24 A warning is printed, if no class-specific diagnostics exists.
25
26 Please consult the class-specific help page for details.
27 }
28 \seealso{
29 \code{\link{diagnostics.deSolve}} for diagnostics of differential
30 equaton solvers.
31 %% enable this when bvpSolve is on CRAN
32 % \code{\link[bvpSolve:diagnostics]{diagnostics.bvpSolve}} for
33 % diagnostics of boundary value problem solvers.
34 }
35
36 \keyword{ utilities }