From 16f5b1d3c0136413e92b2be0f20d365e92e9cd1c Mon Sep 17 00:00:00 2001
From: jranke <jranke@edb9625f-4e0d-4859-8d74-9fd3b1da38cb>
Date: Tue, 18 May 2010 12:58:38 +0000
Subject: Much more complete version that was just submitted to CRAN.

git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/kinfit/pkg/mkin@9 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
---
 man/summary.mkinfit.Rd | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 man/summary.mkinfit.Rd

(limited to 'man/summary.mkinfit.Rd')

diff --git a/man/summary.mkinfit.Rd b/man/summary.mkinfit.Rd
new file mode 100644
index 00000000..1c305899
--- /dev/null
+++ b/man/summary.mkinfit.Rd
@@ -0,0 +1,65 @@
+\name{summary.mkinfit}
+\alias{summary.mkinfit}
+\alias{print.summary.mkinfit}
+\title{
+  Summary method for class "mkinfit".
+}
+\description{
+  Lists model equations, the summary as returned by \code{\link{summary.modFit}},
+  the chi2 error levels calculated according to FOCUS guidance (2006) as far
+  as defined therein, and optionally the data, consisting of observed, predicted
+  and residual values.
+}
+\usage{
+\method{summary}{mkinfit}(object, data = TRUE, distimes = TRUE, cov = FALSE, ...)
+\method{print}{summary.mkinfit}(x, digits = max(3, getOption("digits") - 3), ...)
+}
+
+\arguments{
+  \item{object}{
+  an object of class \code{\link{mkinfit}}.
+}
+  \item{x}{
+  an object of class \code{summary.mkinfit}.
+}
+  \item{data}{
+  logical, indicating whether the data should be included in the summary. 
+}
+  \item{distimes}{
+  logical, indicating whether DT50 and DT90 values shoule be included.
+}
+  \item{cov}{
+  logical, indicating whether parameter covariances should be calculated.
+Passed to \code{\link{summary.modFit}}.  }
+  \item{digits}{
+  Number of digits to use for printing
+}
+  \item{\dots}{
+  optional arguments passed to methods like \code{print}.
+}
+}
+\value{
+  The summary function returns a list with the same components as
+  \code{\link{summary.modFit}}, and the additional components
+  \item{diffs }{The differential equations used in the model}
+  \item{data }{The data (see Description above).}
+  \item{start }{The starting values and bounds, if applicable, for optimised parameters.}
+  \item{fixed }{The values of fixed parameters.}
+  \item{errmin }{The chi2 error levels for each observed variable.}
+  \item{disstimes }{The DT50 and DT90 values for each observed variable.}
+  The print method is called for its side effect, i.e. printing the summary.
+}
+\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://focus.jrc.ec.europa.eu/dk} 
+}
+\author{
+  Johannes Ranke <jranke@harlan.com>
+}
+\examples{
+  summary(mkinfit(mkinmod(parent = list(type = "SFO")), FOCUS_2006_A))
+}
+\keyword{ utilities }
-- 
cgit v1.2.1