diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2019-10-25 00:37:42 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2019-10-25 02:03:54 +0200 |
| commit | 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (patch) | |
| tree | 1bf0ffeb710b3438fee224d0a657606b4c36b495 /man/mkinds.Rd | |
| parent | 053bf27d3f265c7a7378e2df3e00cf891e0d1bb2 (diff) | |
Use roxygen for functions and methods
Diffstat (limited to 'man/mkinds.Rd')
| -rw-r--r-- | man/mkinds.Rd | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/man/mkinds.Rd b/man/mkinds.Rd index 239ab328..0ea562ed 100644 --- a/man/mkinds.Rd +++ b/man/mkinds.Rd @@ -1,3 +1,5 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/mkinds.R \docType{class} \name{mkinds} \alias{mkinds} @@ -11,24 +13,26 @@ A dataset class for mkin } \section{Fields}{ -\describe{ -\item{\code{title}}{A full title for the dataset} -\item{\code{sampling}}{times The sampling times} +\describe{ \item{list("title")}{A full title for the dataset} -\item{\code{time_unit}}{The time unit} +\item{list("sampling")}{times The sampling times} -\item{\code{observed}}{Names of the observed compounds} +\item{list("time_unit")}{The time unit} -\item{\code{unit}}{The unit of the observations} +\item{list("observed")}{Names of the observed compounds} -\item{\code{replicates}}{The number of replicates} +\item{list("unit")}{The unit of the observations} + +\item{list("replicates")}{The number of replicates} + +\item{list("data")}{A dataframe with at least the columns name, time and +value in order to be compatible with mkinfit} } +} -\item{\code{data}}{A dataframe with at least the columns name, time and value -in order to be compatible with mkinfit} -}} \examples{ + mds <- mkinds$new("FOCUS A", FOCUS_2006_A) + } \keyword{datasets} - |