Much more complete version that was just submitted to CRAN.

git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/kinfit/pkg/mkin@9 edb9625f-4e0d-4859-8d74-9fd3b1da38cb

1 files changed, 18 insertions, 13 deletions

diff --git a/man/mkinmod.Rd b/man/mkinmod.Rd
index 4569b317..7ec96277 100644
--- a/man/mkinmod.Rd
+++ b/man/mkinmod.Rd
@@ -9,19 +9,19 @@
   kinetic model type and reaction or transfer to other observed compartments.

 }

 \usage{

-mkinmod(spec = list(parent = list(type = "SFO", to = NA, sink = TRUE)))

+mkinmod(...)

 }

 \arguments{

-  \item{spec}{

-    A list of observed variables to be modelled. Each observed variable has to be 

-    represented by a list with the following entries:

-    \code{type}{ 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. }

-    \code{to}{ A vector of names of variables to which a transfer is to be assumed

-      in the model. }

-    \code{sink}{ Boolean, specifying if transformation to unspecified compounds (sink) 

-      is to be assumed in the model. }

+  \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})

   }

 }

 \value{

@@ -36,9 +36,14 @@ mkinmod(spec = list(parent = list(type = "SFO", to = NA, sink = TRUE)))
   Johannes Ranke <jranke@{harlan.com,uni-bremen.de}>

 }

 \examples{

+# There are different ways to specify the SFO model

+SFO.1 <- mkinmod(parent = list(type = "SFO", to = NULL, sink = TRUE))

+SFO.2 <- mkinmod(parent = list(type = "SFO"))

+all.equal(SFO.1, SFO.2)

+

 # One parent compound, one metabolite, both single first order.

-SFO_SFO <- mkinmod(spec = list(

+SFO_SFO <- mkinmod(

   parent = list(type = "SFO", to = "m1", sink = TRUE),

-  m1 = list(type = "SFO", to = NA, sink = TRUE)))

+  m1 = list(type = "SFO"))

 }

 \keyword{ models }