From 12934520d7ec3218ce1505787b6066334a24a562 Mon Sep 17 00:00:00 2001
From: jranke <jranke@edb9625f-4e0d-4859-8d74-9fd3b1da38cb>
Date: Tue, 30 Mar 2010 19:49:44 +0000
Subject: Initial import of the kinfit package developed from 2008-07 to
 2010-03 at Harlan Laboratories Ltd (former RCC Ltd).

Supports fitting of parent data with the usual FOCUS kinetic models.



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

(limited to 'man/kinreport.Rd')

diff --git a/man/kinreport.Rd b/man/kinreport.Rd
new file mode 100644
index 0000000..de7e632
--- /dev/null
+++ b/man/kinreport.Rd
@@ -0,0 +1,48 @@
+\name{kinreport}
+\Rdversion{1.1}
+\alias{kinreport}
+\title{
+Creates a report of the kinetic fits
+}
+\description{
+Function to create a report for a set of fitted models, passing it to the 
+console as well as to a file, if specified.
+}
+\usage{
+kinreport(kinobject, file = NA, vcov = FALSE, endpoint.digits = 1)
+}
+\arguments{
+  \item{kinobject}{
+	A list containing the following elements:
+	The name of the parent compound to be output (\code{parent}),
+	the type of the test system (\code{type}), 
+	the name of the specific test system used for generating this dataset
+        (\code{system}), 
+	the list of fitted kinetic models (\code{fits}), as returned by
+        \code{\link{kinfit}}, and the list of results (\code{results}) 
+        as returned by \code{\link{kinresults}}.
+	Optionally also
+	the label position of the test compound (\code{label}) and
+	the source of the data (\code{source}). }
+  \item{file}{ The name of the file to which to write. }
+  \item{vcov}{ Should the variance-covariance matrix/matrices be reported? }
+  \item{endpoint.digits}{ How many digits should be reported for DT50 and DT90 values? }
+}
+\value{
+The function is called for its side effect, namely the report being passed
+to the R console as well as to a text file.
+}
+\author{ Johannes Ranke }
+\examples{
+data(FOCUS_2006_A)
+kinfits <- kinfit(FOCUS_2006_A)
+kinobject <- list(
+	parent = "Compound XY",
+	type = "Degradation in the environment",
+	system = "System 1",	
+	source = "Synthetic example data from FOCUS kinetics",
+	fits = kinfits,
+	results = kinresults(kinfits))	
+kinreport(kinobject)
+}
+\keyword{ manip }
-- 
cgit v1.2.1