RateFunctionBuildR: RateFunctionBuildR
In MetaboLouise: METABOlomics LOngitudinal SimUlation Engine

Description Usage Arguments Value Author(s) Examples

View source: R/RateFunctionBuildR.R

Build and visualize an appropriate rate multiplier function. The flow between nodes in the network is governed by certain rates. These rates can be made dependent on the values of the source node (flow from source node to receiver node). With this function you can visualize different types and receive the parameters to be submitted to the simulation function. Note that this function returns an object containing the plot parameters. The simulation function can take only function type.

RateFunctionBuildR(type = c("linear", "sigmoid", "step"),
  C_range = c(0, 200), lin_xy_start = c(0, 0), lin_slope = 0.01,
  sig_C0 = 100, sig_k = 0.05, sig_max = 2, step_levels = c(0, 1,
  2), step_switchpoints = c(50, 150), plot.out = TRUE,
  Nplotpoints = 100)

`type`	Type of the function, any or multiple of "linear", "sigmoid" or "step" can be used.
`C_range`	The range of node concentrations over which to plot the rate function.
`lin_xy_start`	Linear parameter: the starting point for the linear curve e.g. c(0,0).
`lin_slope`	Linear parameter: In case only a single point is provided, the slope is also necessary.
`sig_C0`	Sigmoid parameter: The midpoint concentration.
`sig_k`	Sigmoid parameter: The curve steepness.
`sig_max`	Sigmoid parameter: The maximal height of the function.
`step_levels`	Step function parameter: the distinct levels of the function.
`step_switchpoints`	Step function parameter: The points (nr. of levels minus 1) at which a switch is made.
`plot.out`	Whether to plot the resulting functions.
`Nplotpoints`	The number of plotpoints for the optional plot