summaryrefslogtreecommitdiff
path: root/man/kinreport.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/kinreport.Rd')
-rw-r--r--man/kinreport.Rd11
1 files changed, 9 insertions, 2 deletions
diff --git a/man/kinreport.Rd b/man/kinreport.Rd
index de7e632..f1b8111 100644
--- a/man/kinreport.Rd
+++ b/man/kinreport.Rd
@@ -9,7 +9,7 @@ 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)
+kinreport(kinobject, file = NA, data = TRUE, R2 = FALSE, vcov = FALSE, endpoint.digits = 1)
}
\arguments{
\item{kinobject}{
@@ -18,6 +18,7 @@ kinreport(kinobject, file = NA, vcov = FALSE, endpoint.digits = 1)
the type of the test system (\code{type}),
the name of the specific test system used for generating this dataset
(\code{system}),
+ the input dataset (\code{data}),
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}}.
@@ -25,12 +26,17 @@ kinreport(kinobject, file = NA, vcov = FALSE, endpoint.digits = 1)
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{data}{ Boolean specifying if the input data should be printed? }
+ \item{R2}{ Boolean specifying if the coefficient of determination R2 should
+ be printed. R2 is calculated from all values (not mean values) as 1 - RSS/TSS where
+ RSS is the sum of squares of residuals, and TSS ist the total sum of squares, i.e.
+ the sum of squares of the difference of each observation from the overall mean. }
\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.
+to the R console as well as to a text file if a filename is specified.
}
\author{ Johannes Ranke }
\examples{
@@ -40,6 +46,7 @@ kinobject <- list(
parent = "Compound XY",
type = "Degradation in the environment",
system = "System 1",
+ data = FOCUS_2006_A,
source = "Synthetic example data from FOCUS kinetics",
fits = kinfits,
results = kinresults(kinfits))

Contact - Imprint