name.correl: Help to name parameter 'correl'

In SimEvolEnzCons: Simulation of Evolution of Enzyme Under Constraints

Description

Give the correct abbreviation of the applied constraint, used for parameter correl_fun

Usage

name.correl(is.comp,is.reg,beta_fun=NULL)

Arguments

is.comp	Logical. Is there competition for resources ?
is.reg	Logical. Is there regulation between enzymes ?
beta_fun	Numeric matrix of co-regulation coefficients. Default is NULL, but needed if there is regulation (is.reg==TRUE).

Details

Explored constraints are competition and/or regulation.

If you choose to put regulation, matrix of co-regulation coefficient beta or vector of global co-regulation coefficients B are needed.

See function is.correl.authorized to know possible value of parameter correl_fun.

Value

A character string, used for parameter correl_fun. See possible values in is.correl.authorized.

Examples

#Independence 
name.correl(is.comp=FALSE,is.reg=FALSE)
#returns "SC"

#Regulation
beta <- matrix(c(1,10,5,0.1,1,0.5,0.2,2,1),nrow=3)
name.correl(is.comp=FALSE,is.reg=TRUE,beta_fun=beta)
#returns "RegPos"

SimEvolEnzCons documentation built on Oct. 29, 2021, 1:07 a.m.