From 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Fri, 25 Oct 2019 00:37:42 +0200
Subject: Use roxygen for functions and methods

---
 man/add_err.Rd | 92 +++++++++++++++++++++++++++-------------------------------
 1 file changed, 43 insertions(+), 49 deletions(-)

(limited to 'man/add_err.Rd')

diff --git a/man/add_err.Rd b/man/add_err.Rd
index 00b50878..36b98be9 100644
--- a/man/add_err.Rd
+++ b/man/add_err.Rd
@@ -1,61 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/add_err.R
 \name{add_err}
 \alias{add_err}
-\title{
-  Add normally distributed errors to simulated kinetic degradation data
-}
-\description{
-  Normally distributed errors are added to data predicted for a specific
-  degradation model using \code{\link{mkinpredict}}. The variance of the error
-  may depend on the predicted value and is specified as a standard deviation.
-}
+\title{Add normally distributed errors to simulated kinetic degradation data}
 \usage{
-  add_err(prediction, sdfunc, secondary = c("M1", "M2"),
-          n = 1000, LOD = 0.1, reps = 2,
-          digits = 1, seed = NA)
+add_err(prediction, sdfunc, secondary = c("M1", "M2"), n = 1000,
+  LOD = 0.1, reps = 2, digits = 1, seed = NA)
 }
 \arguments{
-  \item{prediction}{
-    A prediction from a kinetic model as produced by \code{\link{mkinpredict}}.
-  }
-  \item{sdfunc}{
-    A function taking the predicted value as its only argument and returning
-    a standard deviation that should be used for generating the random error
-    terms for this value.
-  }
-  \item{secondary}{
-    The names of state variables that should have an initial value of zero
-  }
-  \item{n}{
-    The number of datasets to be generated.
-  }
-  \item{LOD}{
-    The limit of detection (LOD). Values that are below the LOD after adding
-    the random error will be set to NA.
-  }
-  \item{reps}{
-    The number of replicates to be generated within the datasets.
-  }
-  \item{digits}{
-    The number of digits to which the values will be rounded.
-  }
-  \item{seed}{
-    The seed used for the generation of random numbers. If NA, the seed
-    is not set.
-  }
+\item{prediction}{A prediction from a kinetic model as produced by
+\code{\link{mkinpredict}}.}
+
+\item{sdfunc}{A function taking the predicted value as its only argument and
+returning a standard deviation that should be used for generating the
+random error terms for this value.}
+
+\item{secondary}{The names of state variables that should have an initial
+value of zero}
+
+\item{n}{The number of datasets to be generated.}
+
+\item{LOD}{The limit of detection (LOD). Values that are below the LOD after
+adding the random error will be set to NA.}
+
+\item{reps}{The number of replicates to be generated within the datasets.}
+
+\item{digits}{The number of digits to which the values will be rounded.}
+
+\item{seed}{The seed used for the generation of random numbers. If NA, the
+seed is not set.}
 }
 \value{
-  A list of datasets compatible with \code{\link{mmkin}}, i.e.
-  the components of the list are datasets compatible with
-  \code{\link{mkinfit}}.
+A list of datasets compatible with \code{\link{mmkin}}, i.e. the
+  components of the list are datasets compatible with \code{\link{mkinfit}}.
 }
-\references{
-  Ranke J and Lehmann R (2015) To t-test or not to t-test, that is the question. XV Symposium on Pesticide Chemistry 2-4 September 2015, Piacenza, Italy
-  http://chem.uft.uni-bremen.de/ranke/posters/piacenza_2015.pdf
-}
-\author{
-  Johannes Ranke
+\description{
+Normally distributed errors are added to data predicted for a specific
+degradation model using \code{\link{mkinpredict}}. The variance of the error
+may depend on the predicted value and is specified as a standard deviation.
 }
 \examples{
+
 # The kinetic model
 m_SFO_SFO <- mkinmod(parent = mkinsub("SFO", "M1"),
                      M1 = mkinsub("SFO"), use_of_ff = "max")
@@ -97,5 +82,14 @@ plot(f_SFO_SFO[[3]], show_residuals = TRUE)
 # and plot.mmkin is used
 plot(f_SFO_SFO[1, 3])
 }
+
+}
+\references{
+Ranke J and Lehmann R (2015) To t-test or not to t-test, that is
+the question. XV Symposium on Pesticide Chemistry 2-4 September 2015,
+Piacenza, Italy
+http://chem.uft.uni-bremen.de/ranke/posters/piacenza_2015.pdf
+}
+\author{
+Johannes Ranke
 }
-\keyword{ manip }
-- 
cgit v1.2.1