aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2015-11-06 14:04:19 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2015-11-06 14:04:19 +0100
commit08465aaf96f1d84e345194f0bead2867de352730 (patch)
tree362a62ca3f770158e344eb28fdf14dc737d546dc /man
parentb116635d05647eec6909e844be6034e17ca2f821 (diff)
Add docs for the gmkinws generator and the UBA_model_gallery
Diffstat (limited to 'man')
-rw-r--r--man/UBA_model_gallery.Rd31
-rw-r--r--man/gmkinws.Rd23
2 files changed, 54 insertions, 0 deletions
diff --git a/man/UBA_model_gallery.Rd b/man/UBA_model_gallery.Rd
new file mode 100644
index 0000000..619b6bc
--- /dev/null
+++ b/man/UBA_model_gallery.Rd
@@ -0,0 +1,31 @@
+\name{UBA_model_gallery}
+\alias{UBA_model_gallery}
+\docType{data}
+\title{
+ A collection of some standard kinetic models
+}
+\description{
+ The UBA model gallery contains predefined kinetic models for some common use
+ cases, with metabolites named as in the commonly used PELMO degradation
+ scheme (Jene 1998). Please use the model gallery of the \code{\link{gmkin}}
+ GUI to see their definitions. The models use the topology of the models
+ defined by Michael Klein (2010) for DegKinManager, with the exception of the
+ kinetic sorption model.
+}
+\usage{data("UBA_model_gallery")}
+\format{
+ A list containing 9 lists of four \code{\link{mkinmod}} models.
+}
+\references{
+ Klein M (2010) Calculation of rates constants according to FOCUS degradation
+ kinetics using DegKinManager and ModelMaker. Project report of UBA project
+ FKZ 360 03 048
+
+ Jene B (1998) PELMO 3.00 Manual extension, Staatliche Lehr- und
+ Forschungsanstalt für Landwirtschaft, Weinbau und Gartenbau, D-67435
+ Neustadt/Wstr.
+}
+\examples{
+data(UBA_model_gallery)
+}
+\keyword{datasets}
diff --git a/man/gmkinws.Rd b/man/gmkinws.Rd
new file mode 100644
index 0000000..5fab955
--- /dev/null
+++ b/man/gmkinws.Rd
@@ -0,0 +1,23 @@
+\docType{class}
+\name{gmkinws}
+\alias{gmkinws}
+\title{A workspace class for gmkin}
+\format{An \code{\link{R6Class}} generator object.}
+\usage{
+gmkinws
+}
+\description{
+Datasets, models and fits are stored in lists.
+}
+\section{Fields}{
+
+\describe{
+\item{\code{observed}}{Names of the observed variables in the datasets, named
+by the names used in the models contained in field m}
+
+\item{\code{ds}}{A list of datasets compatible with mkinfit (long format)}
+
+\item{\code{m}}{A list of mkinmod models}
+
+\item{\code{f}}{A list of mkinfit objects}
+}}

Contact - Imprint