LIMbuild: Setting up and checking the LIM file formatting

Description Usage Arguments Details Value Note Author(s) Examples

View source: R/LIMbuild.R

Description

Setting up of the LIM package and the enaR package is done in this function thus there is no need to do it prior e.g. using the functions Read or Setup from the LIM package. When preparing to use the LIM file, this method will prompt the user to verify that the information output correctly represents what was intened. Respiration node/element is required to be first in the externals list. To correctly identify living or non-living nodes, all non-living nodes are required to have ‘NLNode’ at the end of the node name i.e. detritus would be detNLNode or detritusNLNode.

Usage

1
LIMbuild(Rfile)

Arguments

Rfile

This is the user generated R text file defining the network.

Details

Used primarily for the FlowCAr package, this is a method simply for preparation and verification purposes that need not be run if entirely sure the requirements are met. If processing is conducted and results aren't what is expected, run this method to verify the lim file is set up correctly to fulfill the requiremnts.

Displayed in the console will be indications as to what data will be used for which calculation, however, it is up to the user to notice if anything is incorrect.

Value

See "value" in Setup Console output depicting information about what processing will be done.

Note

This function does no calculations and is not a necessity in order to proceed with the preparing of ENA network objects in this package.

Author(s)

Ruchit Mahabir

Christopher Waspe

Ursula Scharler

Examples

1
2
3
4
5
6
7
8
9
##------------------------------------------------------------##
## A simple four node network                                 ##
##------------------------------------------------------------##

  data(N4)

  #Output generated using the following code

  N4 <- LIMbuild (Rfile = "4node.R")

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