kinfit (version 1.1.14)

kinreport: 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, data = TRUE, R2 = FALSE,  vcov = FALSE, endpoint.digits = 1)

Arguments

kinobject

A list containing the following elements: The name of the parent compound to be output (parent), the type of the test system (type), the name of the specific test system used for generating this dataset (system), the input dataset (data), the list of fitted kinetic models (fits), as returned by kinfit, and the list of results (results) as returned by kinresults. Optionally also the label position of the test compound (label) and the source of the data (source).

file

The name of the file to which to write.

data

Boolean specifying if the input data should be printed?

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.

vcov

Should the variance-covariance matrix/matrices be reported?

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 if a filename is specified.

Examples

data(FOCUS_2006_A)
kinfits <- kinfit(FOCUS_2006_A)
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))	
kinreport(kinobject)