Use roxygen for functions and methods

1 files changed, 52 insertions, 54 deletions

diff --git a/man/mkinerrmin.Rd b/man/mkinerrmin.Rd
index 25aba7c0..be929130 100644
--- a/man/mkinerrmin.Rd
+++ b/man/mkinerrmin.Rd
@@ -1,54 +1,52 @@
-\name{mkinerrmin}

-\alias{mkinerrmin}

-\title{

-Calculate the minimum error to assume in order to pass the variance test

-}

-\description{

-This function finds the smallest relative error still resulting in passing the

-chi-squared test as defined in the FOCUS kinetics report from 2006.

-}

-\usage{

-mkinerrmin(fit, alpha = 0.05)

-}

-\arguments{

-  \item{fit}{

-    an object of class \code{\link{mkinfit}}.

-  }

-  \item{alpha}{

-    The confidence level chosen for the chi-squared test.

-}

-}

-\value{

-  A dataframe with the following components:

-  \item{err.min}{The relative error, expressed as a fraction.}

-  \item{n.optim}{The number of optimised parameters attributed to the data series.}

-  \item{df}{The number of remaining degrees of freedom for the chi2 error level

-    calculations.  Note that mean values are used for the chi2 statistic and

-    therefore every time point with observed values in the series only counts

-    one time.}

-  The dataframe has one row for the total dataset and one further row for

-  each observed state variable in the model.

-}

-\details{

-    This function is used internally by \code{\link{summary.mkinfit}}.

-}

-\examples{

-SFO_SFO = mkinmod(parent = mkinsub("SFO", to = "m1"),

-                  m1 = mkinsub("SFO"),

-                  use_of_ff = "max")

-

-fit_FOCUS_D = mkinfit(SFO_SFO, FOCUS_2006_D, quiet = TRUE)

-round(mkinerrmin(fit_FOCUS_D), 4)

-\dontrun{

-  fit_FOCUS_E = mkinfit(SFO_SFO, FOCUS_2006_E, quiet = TRUE)

-  round(mkinerrmin(fit_FOCUS_E), 4)

-}

-}

-\references{ 

-  FOCUS (2006) \dQuote{Guidance Document on Estimating Persistence and

-  Degradation Kinetics from Environmental Fate Studies on Pesticides in EU

-  Registration} Report of the FOCUS Work Group on Degradation Kinetics,

-  EC Document Reference Sanco/10058/2005 version 2.0, 434 pp,

-  \url{http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics} 

-}

-\keyword{ manip }

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/mkinerrmin.R
+\name{mkinerrmin}
+\alias{mkinerrmin}
+\title{Calculate the minimum error to assume in order to pass the variance test}
+\usage{
+mkinerrmin(fit, alpha = 0.05)
+}
+\arguments{
+\item{fit}{an object of class \code{\link{mkinfit}}.}
+
+\item{alpha}{The confidence level chosen for the chi-squared test.}
+}
+\value{
+A dataframe with the following components: \item{err.min}{The
+relative error, expressed as a fraction.} \item{n.optim}{The number of
+optimised parameters attributed to the data series.} \item{df}{The number of
+remaining degrees of freedom for the chi2 error level calculations.  Note
+that mean values are used for the chi2 statistic and therefore every time
+point with observed values in the series only counts one time.} The
+dataframe has one row for the total dataset and one further row for each
+observed state variable in the model.
+}
+\description{
+This function finds the smallest relative error still resulting in passing
+the chi-squared test as defined in the FOCUS kinetics report from 2006.
+}
+\details{
+This function is used internally by \code{\link{summary.mkinfit}}.
+}
+\examples{
+
+SFO_SFO = mkinmod(parent = mkinsub("SFO", to = "m1"),
+                  m1 = mkinsub("SFO"),
+                  use_of_ff = "max")
+
+fit_FOCUS_D = mkinfit(SFO_SFO, FOCUS_2006_D, quiet = TRUE)
+round(mkinerrmin(fit_FOCUS_D), 4)
+\dontrun{
+  fit_FOCUS_E = mkinfit(SFO_SFO, FOCUS_2006_E, quiet = TRUE)
+  round(mkinerrmin(fit_FOCUS_E), 4)
+}
+
+}
+\references{
+FOCUS (2006) \dQuote{Guidance Document on Estimating Persistence
+and Degradation Kinetics from Environmental Fate Studies on Pesticides in EU
+Registration} Report of the FOCUS Work Group on Degradation Kinetics, EC
+Document Reference Sanco/10058/2005 version 2.0, 434 pp,
+\url{http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics}
+}
+\keyword{manip}