diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/mkinds.Rd | 34 | ||||
-rw-r--r-- | man/print.mkinds.Rd | 19 |
2 files changed, 53 insertions, 0 deletions
diff --git a/man/mkinds.Rd b/man/mkinds.Rd new file mode 100644 index 00000000..239ab328 --- /dev/null +++ b/man/mkinds.Rd @@ -0,0 +1,34 @@ +\docType{class} +\name{mkinds} +\alias{mkinds} +\title{A dataset class for mkin} +\format{An \code{\link{R6Class}} generator object.} +\usage{ +mkinds +} +\description{ +A dataset class for mkin +} +\section{Fields}{ + +\describe{ +\item{\code{title}}{A full title for the dataset} + +\item{\code{sampling}}{times The sampling times} + +\item{\code{time_unit}}{The time unit} + +\item{\code{observed}}{Names of the observed compounds} + +\item{\code{unit}}{The unit of the observations} + +\item{\code{replicates}}{The number of replicates} + +\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} + diff --git a/man/print.mkinds.Rd b/man/print.mkinds.Rd new file mode 100644 index 00000000..e7acf30d --- /dev/null +++ b/man/print.mkinds.Rd @@ -0,0 +1,19 @@ +\name{print.mkinds} +\alias{print.mkinds} +\title{ + Print mkinds objects +} +\description{ + Print mkinds objects. +} +\usage{ +\method{print}{mkinds}(x, ...) +} +\arguments{ + \item{x}{ + An \code{\link{mkinds}} object. + } + \item{\dots}{ + Not used. + } +} |