enaListGen: A one step method which creates a list of the limfile, list...

In FlowCAr: Flow Network Construction and Analysis

Description

The main function enaListGen produces a list which contains the limfile (created through LIMbuild), the list of LIM networks (created through limListGen) and the list of enaR network objects. The enaR network objects are created from a specified LIM input file, ready for use in enaR.

Usage

enaListGen(Rfile, limfile, limList, limName, limListName, enaListName, 
           storeAll, flowCheck, ...)

Arguments

Rfile	This is the user generated R text file defining the network.
limfile	The created limfile (LIMbuild)
limList	The list of networks solved using LIM (limListGen)
limName	If no limfile exists, the name of the limfile for the function to output
limListName	If no limList exists, the name of the limList for the function to output
enaListName	The name of the enaR network object list for the function to output
storeAll	Boolean. Indicates whether to store each enaR component as a separate list.
flowCheck	Boolean. Indicates whether to run flowCheck function.
...	Parameters avaliable through the use of the xsample function.

Value

A list containing three objects

[[1]] The limfile

[[2]] The list of LIM networks

[[3]] The list of enaR network objects

Author(s)

Ruchit Mahabir

Christopher Waspe

Ursula Scharler

Examples

#All steps in one
data(N4list)
N4list <- enaListGen("4node.R", limName = "lim4",
                   limListName = "ll4", enaListName = "ena4",storeAll = FALSE,
                   flowCheck = FALSE, iter = 10000, jmp = NULL)
                   
#creates the following object

###If the limfile and limList has been created
N4LIM <- data(N4LIM)
N4list <- enaListGen(limfile = N4,limList = N4LIM, enaListName = "ena4")
###If only the limfile has been created
N4list <- enaListGen(limfile = N4,limListName = "lim4node",enaListName = "ena4",
                       iter = 10000, jmp = NULL)

FlowCAr documentation built on Sept. 30, 2019, 5:04 p.m.