aboutsummaryrefslogtreecommitdiff
path: root/man/mkinmod.Rd
diff options
context:
space:
mode:
authorjranke <jranke@edb9625f-4e0d-4859-8d74-9fd3b1da38cb>2012-03-15 15:54:14 +0000
committerjranke <jranke@edb9625f-4e0d-4859-8d74-9fd3b1da38cb>2012-03-15 15:54:14 +0000
commit1718d434efae26de02754c6622c43f4dc9e624b9 (patch)
treec2dafe942f65e94cd43e1ba17933b667f284d154 /man/mkinmod.Rd
parent2b244ef7d3cbebaaa653d8c8ac87090e34525f7a (diff)
Update kinfit and mkin to the latest version published on BerliOS.
git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/kinfit/pkg/mkin@17 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
Diffstat (limited to 'man/mkinmod.Rd')
-rw-r--r--man/mkinmod.Rd18
1 files changed, 11 insertions, 7 deletions
diff --git a/man/mkinmod.Rd b/man/mkinmod.Rd
index 7ec9627..7c11735 100644
--- a/man/mkinmod.Rd
+++ b/man/mkinmod.Rd
@@ -15,13 +15,16 @@ mkinmod(...)
\item{...}{
For each observed variable, a list has to be specified as an argument, containing
at least a component \code{type}, specifying the type of kinetics to use
- for the variable. Currently, only single first order kinetics "SFO" or
- single first order with reversible binding "SFORB" are implemented, as well as
- "FOMC" for the first compartment which is assumed to be the source compartment.
- Optional components of each argument are \code{to}, a vector of names of
- variables to which a transfer is to be assumed in the model, and
- \code{sink}, a logical specifying if transformation to unspecified
- compounds (sink) is to be assumed in the model (defaults to \code{TRUE})
+ for the variable. Currently, single first order kinetics "SFO" or
+ single first order with reversible binding "SFORB" are implemented for all
+ variables, while
+ "FOMC", "DFOP" and "HS" can additionally be chosen for the first
+ variable which is assumed to be the source compartment. Optional components
+ of each argument are \code{to}, a
+ vector of names of variables to which a transfer is to be assumed in the
+ model, and \code{sink}, a logical specifying if transformation to
+ unspecified compounds (sink) is to be assumed in the model (defaults to
+ \code{TRUE})
}
}
\value{
@@ -31,6 +34,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{coefmat}{ The coefficient matrix, if the system of differential equations can be represented by one. }
}
\author{
Johannes Ranke <jranke@{harlan.com,uni-bremen.de}>

Contact - Imprint