From 2fc3f680f8621f9b78d5c10184ee8e9e49206f82 Mon Sep 17 00:00:00 2001 From: jranke Date: Mon, 16 Apr 2012 22:11:48 +0000 Subject: Overhaul of mkinmod in order to make it possible to choose between different model specifications - a variant with minimal use of formation fractions, and a variant with formation fractions everywhere. git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/kinfit/pkg/mkin@26 edb9625f-4e0d-4859-8d74-9fd3b1da38cb --- man/mkinmod.Rd | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'man') diff --git a/man/mkinmod.Rd b/man/mkinmod.Rd index 16ad38a..b528d83 100644 --- a/man/mkinmod.Rd +++ b/man/mkinmod.Rd @@ -9,7 +9,7 @@ kinetic model type and reaction or transfer to other observed compartments. } \usage{ -mkinmod(...) +mkinmod(..., use_of_ff = "min") } \arguments{ \item{...}{ @@ -23,6 +23,15 @@ mkinmod(...) Additionally, each component of the list can include a character vector \code{to}, specifying names of variables to which a transfer is to be assumed in the model. + If the argument \code{use_of_ff} is set to "min" (default) and the model for + the compartment is "SFO" or "SFORB", an additional component of the list + can be "sink=FALSE" effectively fixing the flux to sink to zero. + } + \item{use_of_ff}{ + Specification of the use of formation fractions in the model equations and, if + applicable, the coefficient matrix. If "min", a minimum use of formation + fractions is made in order to avoid fitting the product of formation fractions + and rate constants. If "max", formation fractions are always used. } } \value{ @@ -32,6 +41,7 @@ mkinmod(...) \item{parms}{ A vector of parameter names occurring in the differential equations. } \item{map}{ A list containing named character vectors for each observed variable, specifying the modelling variables by which it is represented. } + \item{use_of_ff}{ The content of \code{use_of_ff} is passed on in this list component. } \item{coefmat}{ The coefficient matrix, if the system of differential equations can be represented by one. } } \author{ -- cgit v1.2.1