num_info: Print information about numerical solver result

View source: R/numerics.R

num_infoR Documentation

Print information about numerical solver result

Description

[Experimental]

Usage

num_info(obj)

## Default S3 method:
num_info(obj)

## S3 method for class 'cvasi_simulate'
num_info(obj)

## S3 method for class 'cvasi_fit'
num_info(obj)

Arguments

obj

Return value of simulate()

Details

Prints information on the status of a return value from simulate(), e.g. if it was successful and what, if any, issues occurred. Also provides tips on solving frequently occurring issues.

The function requires certain metadata which is created by deSolve::ode() and is passed through to the result of simulate(). The metadata may be lost if the data.frame returned by simulate() is converted or cast to other types.

See Also

diagnostics()

Examples

# A simulation without any issues
minnow_it %>% simulate() %>% num_info()

# A simulation which terminated early due to the solver
# taking too many numerical steps
rs <- suppressWarnings(minnow_it %>% simulate(hmax=1e-80))
num_info(rs)

# Print deSolve diagnostics for additional information
diagnostics(rs)

cvasi documentation built on Sept. 11, 2025, 5:11 p.m.