sybil: getFluxDist-methods – R documentation

Pricing

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

Get Started for Free

Documentation

sybil

getFluxDist-methods

Retrieve Flux Distribution

Description

Get all primal values of variables after optimization (the resulting flux distribution).

Usage

## S4 method for signature 'optObj_clpAPI'
getFluxDist(lp)

## S4 method for signature 'optObj_cplexAPI'
getFluxDist(lp)

## S4 method for signature 'optObj_glpkAPI'
getFluxDist(lp)

## S4 method for signature 'optObj_lpSolveAPI'
getFluxDist(lp)

## S4 method for signature 'optsol'
getFluxDist(lp, react = NULL, opt = NULL, drop = TRUE)

Arguments

`lp`	An object extending class `optObj` or class `optsol`.
`react`	Numeric vector or object of class `reactId` indicating the reactions (rows of the flux distribution) to return. Default: `NULL`.
`opt`	Numeric vector indicating the optimizations (columns of the flux distribution) to return. Default: `NULL`.
`drop`	Used for array subsetting like in `[`. Default: `TRUE`.

Value

A numeric matrix or vector containing all primal values (the flux distribution).

Methods

signature(lp = "optObj_clpAPI"): method to use with package optObj_clpAPI.
signature(lp = "optObj_cplexAPI"): method to use with package optObj_cplexAPI.
signature(lp = "optObj_glpkAPI"): method to use with package optObj_glpkAPI.
signature(lp = "optObj_lpSolveAPI"): method to use with package optObj_lpSolveAPI.
signature(lp = "optsol"): method to use with objects of class optsol. Returns a subset of the flux distribution stored in slot fluxdist as object of class Matrix. If arguments react and opt are both set to NULL (default), the flux distribution corresponding to the variable indices in slot fldind will be returned.

Author(s)

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

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