From 1511ed0a775e15ec2158e22d08a4da00cdd834aa Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 16 Nov 2017 17:13:35 +0100 Subject: Use html_vignette for FOCUS_D vignette, fix address Static documentation articles rebuilt by pkgdown::build_articles() --- vignettes/FOCUS_D.Rmd | 4 +- vignettes/FOCUS_D.html | 179 +++++++++++++++---------------------------------- vignettes/FOCUS_Z.Rmd | 2 +- vignettes/FOCUS_Z.html | 6 +- vignettes/mkin.Rmd | 2 +- vignettes/mkin.html | 19 ++---- 6 files changed, 67 insertions(+), 145 deletions(-) (limited to 'vignettes') diff --git a/vignettes/FOCUS_D.Rmd b/vignettes/FOCUS_D.Rmd index 40bcb157..9cb9c529 100644 --- a/vignettes/FOCUS_D.Rmd +++ b/vignettes/FOCUS_D.Rmd @@ -3,10 +3,8 @@ title: Example evaluation of FOCUS Example Dataset D author: Johannes Ranke date: "`r Sys.Date()`" output: - html_document: + html_vignette: mathjax: null - theme: united - fig_retina: null vignette: > %\VignetteIndexEntry{Example evaluation of FOCUS Example Dataset D} %\VignetteEngine{knitr::rmarkdown} diff --git a/vignettes/FOCUS_D.html b/vignettes/FOCUS_D.html index 44bbe062..abd7d129 100644 --- a/vignettes/FOCUS_D.html +++ b/vignettes/FOCUS_D.html @@ -8,130 +8,75 @@ + - + Example evaluation of FOCUS Example Dataset D - - - - - - - - - + - - - + - - - - -
- - - - - - - - - - - -

This is just a very simple vignette showing how to fit a degradation model for a parent compound with one transformation product using mkin. After loading the library we look a the data. We have observed concentrations in the column named value at the times specified in column time for the two observed variables named parent and m1.

-
library("mkin")
-
## Loading required package: minpack.lm
-
## Loading required package: rootSolve
-
## Loading required package: inline
-
## Loading required package: methods
-
## Loading required package: parallel
-
print(FOCUS_2006_D)
+
library("mkin")
+print(FOCUS_2006_D)
##      name time  value
 ## 1  parent    0  99.46
 ## 2  parent    0 102.04
@@ -179,27 +124,27 @@ $(document).ready(function () {
 ## 44     m1  120  33.31

Next we specify the degradation model: The parent compound degrades with simple first-order kinetics (SFO) to one metabolite named m1, which also degrades with SFO kinetics.

The call to mkinmod returns a degradation model. The differential equations represented in R code can be found in the character vector $diffs of the mkinmod object. If a C compiler (gcc) is installed and functional, the differential equation model will be compiled from auto-generated C code.

-
SFO_SFO <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
+
SFO_SFO <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
## Successfully compiled differential equation model from auto-generated C code.
-
print(SFO_SFO$diffs)
+
print(SFO_SFO$diffs)
##                                                       parent 
 ## "d_parent = - k_parent_sink * parent - k_parent_m1 * parent" 
 ##                                                           m1 
 ##             "d_m1 = + k_parent_m1 * parent - k_m1_sink * m1"

We do the fitting without progress report (quiet = TRUE).

-
fit <- mkinfit(SFO_SFO, FOCUS_2006_D, quiet = TRUE)
+
fit <- mkinfit(SFO_SFO, FOCUS_2006_D, quiet = TRUE)

A plot of the fit including a residual plot for both observed variables is obtained using the plot_sep method for mkinfit objects, which shows separate graphs for all compounds and their residuals.

-
plot_sep(fit, lpos = c("topright", "bottomright"))
-

+
plot_sep(fit, lpos = c("topright", "bottomright"))
+

Confidence intervals for the parameter estimates are obtained using the mkinparplot function.

-
mkinparplot(fit)
+
mkinparplot(fit)

A comprehensive report of the results is obtained using the summary method for mkinfit objects.

-
summary(fit)
-
## mkin version:    0.9.45.2 
-## R version:       3.4.1 
-## Date of fit:     Fri Jul 21 18:02:19 2017 
-## Date of summary: Fri Jul 21 18:02:20 2017 
+
summary(fit)
+
## mkin version:    0.9.46.2 
+## R version:       3.4.2 
+## Date of fit:     Thu Nov 16 17:07:26 2017 
+## Date of summary: Thu Nov 16 17:07:27 2017 
 ## 
 ## Equations:
 ## d_parent/dt = - k_parent_sink * parent - k_parent_m1 * parent
@@ -207,7 +152,7 @@ $(document).ready(function () {
 ## 
 ## Model predictions using solution type deSolve 
 ## 
-## Fitted with method Port using 153 model solutions performed in 1.059 s
+## Fitted with method Port using 153 model solutions performed in 1.031 s
 ## 
 ## Weighting: none
 ## 
@@ -322,21 +267,5 @@ $(document).ready(function () {
 
 
 
-
- - - - diff --git a/vignettes/FOCUS_Z.Rmd b/vignettes/FOCUS_Z.Rmd index e88eceb5..d61f7387 100644 --- a/vignettes/FOCUS_Z.Rmd +++ b/vignettes/FOCUS_Z.Rmd @@ -15,7 +15,7 @@ vignette: > %\VignetteEncoding{UTF-8} --- -[Wissenschaftlicher Berater, Kronacher Str. 8, 79639 Grenzach-Wyhlen, Germany](http://www.jrwb.de)
+[Wissenschaftlicher Berater, Kronacher Str. 12, 79639 Grenzach-Wyhlen, Germany](http://www.jrwb.de)
[Privatdozent at the University of Bremen](http://chem.uft.uni-bremen.de/ranke) ```{r, include = FALSE} diff --git a/vignettes/FOCUS_Z.html b/vignettes/FOCUS_Z.html index 0437075c..369e913d 100644 --- a/vignettes/FOCUS_Z.html +++ b/vignettes/FOCUS_Z.html @@ -11,7 +11,7 @@ - + Example evaluation of FOCUS dataset Z @@ -234,12 +234,12 @@ div.tocify {

Example evaluation of FOCUS dataset Z

Johannes Ranke

-

2017-09-14

+

2017-11-16

-

Wissenschaftlicher Berater, Kronacher Str. 8, 79639 Grenzach-Wyhlen, Germany
Privatdozent at the University of Bremen

+

Wissenschaftlicher Berater, Kronacher Str. 12, 79639 Grenzach-Wyhlen, Germany
Privatdozent at the University of Bremen

The data

The following code defines the example dataset from Appendix 7 to the FOCUS kinetics report (FOCUS Work Group on Degradation Kinetics 2014, 354).

diff --git a/vignettes/mkin.Rmd b/vignettes/mkin.Rmd index e3cac1d1..84bc5adb 100644 --- a/vignettes/mkin.Rmd +++ b/vignettes/mkin.Rmd @@ -15,7 +15,7 @@ vignette: > %\VignetteEncoding{UTF-8} --- -[Wissenschaftlicher Berater, Kronacher Str. 8, 79639 Grenzach-Wyhlen, Germany](http://www.jrwb.de)
+[Wissenschaftlicher Berater, Kronacher Str. 12, 79639 Grenzach-Wyhlen, Germany](http://www.jrwb.de)
[Privatdozent at the University of Bremen](http://chem.uft.uni-bremen.de/ranke) ```{r, include = FALSE} diff --git a/vignettes/mkin.html b/vignettes/mkin.html index 5c9c1a84..f87c967f 100644 --- a/vignettes/mkin.html +++ b/vignettes/mkin.html @@ -11,7 +11,7 @@ - + Introduction to mkin @@ -234,22 +234,17 @@ div.tocify {

Introduction to mkin

Johannes Ranke

-

2017-07-21

+

2017-11-16

-

Wissenschaftlicher Berater, Kronacher Str. 8, 79639 Grenzach-Wyhlen, Germany
Privatdozent at the University of Bremen

+

Wissenschaftlicher Berater, Kronacher Str. 12, 79639 Grenzach-Wyhlen, Germany
Privatdozent at the University of Bremen

Abstract

In the regulatory evaluation of chemical substances like plant protection products (pesticides), biocides and other chemicals, degradation data play an important role. For the evaluation of pesticide degradation experiments, detailed guidance has been developed, based on nonlinear optimisation. The R add-on package mkin (Ranke 2016) implements fitting some of the models recommended in this guidance from within R and calculates some statistical measures for data series within one or more compartments, for parent and metabolites.

-
library(mkin)
-
## Loading required package: minpack.lm
-
## Loading required package: rootSolve
-
## Loading required package: inline
-
## Loading required package: methods
-
## Loading required package: parallel
-
# Define the kinetic model
+
library(mkin)
+# Define the kinetic model
 m_SFO_SFO_SFO <- mkinmod(parent = mkinsub("SFO", "M1"),
                          M1 = mkinsub("SFO", "M2"),
                          M2 = mkinsub("SFO"),
@@ -276,7 +271,7 @@ f_SFO_SFO_SFO <- mkinfit(m_SFO_SFO_SFO, d_SFO_SFO_SFO_err[[1]], quiet = TRUE)
 
 # Plot the results separately for parent and metabolites
 plot_sep(f_SFO_SFO_SFO, lpos = c("topright", "bottomright", "bottomright"))
-

+

Background

@@ -293,7 +288,7 @@ plot_sep(f_SFO_SFO_SFO, lpos = c("topright", "bottomright",

Soon after the publication of mkin, two derived tools were published, namely KinGUII (available from Bayer Crop Science) and CAKE (commissioned to Tessella by Syngenta), which added a graphical user interface (GUI), and added fitting by iteratively reweighted least squares (IRLS) and characterisation of likely parameter distributions by Markov Chain Monte Carlo (MCMC) sampling.

CAKE focuses on a smooth use experience, sacrificing some flexibility in the model definition, originally allowing only two primary metabolites in parallel. The current version 3.2 of CAKE release in March 2016 uses a basic scheme for up to six metabolites in a flexible arrangement, but does not support back-reactions (non-instantaneous equilibria) or biphasic kinetics for metabolites.

KinGUI offers an even more flexible widget for specifying complex kinetic models. Back-reactions (non-instanteneous equilibria) were supported early on, but until 2014, only simple first-order models could be specified for transformation products. Starting with KinGUII version 2.1, biphasic modelling of metabolites was also available in KinGUII.

-

A further graphical user interface (GUI) that has recently been brought to a decent degree of maturity is the browser based GUI named gmkin. Please see its documentation page and manual for further information.

+

A further graphical user interface (GUI) that has recently been brought to a decent degree of maturity is the browser based GUI named gmkin. Please see its documentation page and manual for further information.

Recent developments

-- cgit v1.2.1