marginals_check: marginals_check

In pik-piam/gdx: Interface package for GDX files in R

marginals_check

Description

This function returns a list of the highest marginals found in gdx file allowing to detect the most critical constraints in a given solution.

Usage

marginals_check(gdx, ifilter=NULL, efilter=NULL, limit=1e5,
scientific=TRUE, unlist=FALSE, name="o(v|q)*")

Arguments

gdx	a GDX list as created by readGDX, or the file name of a gdx file
ifilter	Inclusion filter. A vector of strings containing regular expressions which describe strings that have to be part of the found marginal names. Otherwise they will be excluded.
efilter	Exclusion filter. A vector of strings containing regular expressions which describe strings must not be part of the found marginal names. Otherwise they will be excluded.
limit	Lower limit for the absolute value of the marginal in order to be part of the output.
scientific	Boolean which decides whether the marginals should be written scientfically (e.g. 1e+2) or the default output scheme should be used.
unlist	If TRUE a vector sorted by the rank of the marginal will be returned, otherwise a structured list of outputs will be returned.
name	search string defining the objects that should be read from gdx file, with *-autocompletion. Can also be a vector containing more than one search strings

Value

A vector or list containing all marginals which absolute values are above the given limit and which agree with the given filters.

Author(s)

Jan Philipp Dietrich

See Also

readGDX

Examples

## Not run: marginals_check("fulldata.gdx")

pik-piam/gdx documentation built on March 12, 2024, 10:30 a.m.