sybil: checkOptSol-methods – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

checkOptSol-methods

Summarized Information About an Object of Class Optsol

Description

The function checkOptSol evaluates the results of the solution of optimizations; the returned objects e.g. from optimizeProb.

Usage

## S4 method for signature 'optsol'
checkOptSol(opt, onlywarn = FALSE)

Arguments

`opt`	An object of class `optsol`.
`onlywarn`	A single Boolean value. If set to `TRUE`, the method will check, if all optimizations ended successfully. Default: `FALSE`.

Details

The function checkOptSol is used by functions performing a linear optimization (e.g. optimizeProb). In that case, the argument onlywarn is set to TRUE. If the optimization ends unsuccesfull, a warning will be produced.

It is also possible to use the function directly, with onlywarn set to FALSE (the default). In that case, an object of class checksol will be retuned. This object contains a summary with the exit status of the optimization.

Value

TRUE or FALSE if onlywarn is set to TRUE, otherwise an object of class checksol.

Methods

signature(opt = "optsol"): method to use with objects of class optsol.

Author(s)

Gabriel Gelius-Dietrich <geliudie@uni-duesseldorf.de>

Maintainer: Mayo Roettger <mayo.roettger@hhu.de>

Examples

data(Ec_core)
  Ec_f <- optimizeProb(Ec_core, retOptSol = TRUE)
  Ec_check <- checkOptSol(Ec_f)

sybil

Efficient Constrained Based Modelling

v2.1.5

GPL-3 | file LICENSE

Authors

Mayo Roettger [cre], Gabriel Gelius-Dietrich [aut], C. Jonathan Fritzemeier [ctb], Rajen Piernikarczyk [ctb], Marc Andre Daxer [ctb], Benjamin Braasch [ctb], Abdelmoneim Desouki [ctb], Martin J. Lercher [ctb]

Initial release

2019-03-07