diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2017-03-04 09:58:00 +0100 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2017-03-04 09:58:00 +0100 |
| commit | 3010c9dcbc7f90f15b55c14919f6688d61d14414 (patch) | |
| tree | 781d9678bd25b451bce0c7b6d47e396be9c6ca1c /docs/index.html | |
| parent | b847fec686bc1db59079412eb18063d3514ecf75 (diff) | |
Mention pkgdown.jrwb.de/mkin in README
Add very small twa vignette, update pkgdown docs
Diffstat (limited to 'docs/index.html')
| -rw-r--r-- | docs/index.html | 97 |
1 files changed, 68 insertions, 29 deletions
diff --git a/docs/index.html b/docs/index.html index a8d8521d..4ec9fd79 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,8 +1,20 @@ <!DOCTYPE html> -<!-- Generated by pkgdown: do not edit by hand --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Kinetic Evaluation of Chemical Degradation Data • mkin</title><!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"><script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous"><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet"><script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><!-- mathjax --><script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><!--[if lt IE 9]> +<!-- Generated by pkgdown: do not edit by hand --><html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<meta charset="utf-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title>Kinetic Evaluation of Chemical Degradation Data • mkin</title> +<!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous"> +<!-- pkgdown --><link href="pkgdown.css" rel="stylesheet"> +<script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><!-- mathjax --><script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> -<![endif]--></head><body> +<![endif]--> +</head> +<body> <div class="container template-home"> <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="container"> @@ -15,7 +27,8 @@ <a class="navbar-brand" href="index.html">mkin</a> </div> <div id="navbar" class="navbar-collapse collapse"> - <ul class="nav navbar-nav"><li> + <ul class="nav navbar-nav"> +<li> <a href="reference/index.html">Functions and data</a> </li> <li class="dropdown"> @@ -24,7 +37,8 @@ <span class="caret"></span> </a> - <ul class="dropdown-menu" role="menu"><li> + <ul class="dropdown-menu" role="menu"> +<li> <a href="articles/mkin.html">Introduction to mkin</a> </li> <li> @@ -36,25 +50,33 @@ <li> <a href="articles/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a> </li> - </ul></li> + </ul> +</li> <li> <a href="news/index.html">News</a> </li> - </ul><ul class="nav navbar-nav navbar-right"><li> + </ul> +<ul class="nav navbar-nav navbar-right"> +<li> <a href="http://github.com/jranke/mkin"> <span class="fa fa-github fa-lg"></span> </a> </li> - </ul></div><!--/.nav-collapse --> - </div><!--/.container --> -</div><!--/.navbar --> + </ul> +</div> +<!--/.nav-collapse --> + </div> +<!--/.container --> +</div> +<!--/.navbar --> </header><div class="row"> <div class="contents col-md-9"> <div id="mkin" class="section level1"> -<div class="page-header"><h1 class="hasAnchor"><a href="#mkin" class="anchor"> </a>mkin</h1></div> +<div class="page-header"><h1 class="hasAnchor"> +<a href="#mkin" class="anchor"> </a>mkin</h1></div> <p>The R package <strong>mkin</strong> provides calculation routines for the analysis of chemical degradation data, including <b>m</b>ulticompartment <b>kin</b>etics as needed for modelling the formation and decline of transformation products, or if several compartments are involved.</p> <div id="installation" class="section level2"> @@ -66,7 +88,7 @@ <div id="background" class="section level2"> <h2 class="hasAnchor"> <a href="#background" class="anchor"> </a>Background</h2> -<p>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 and helpful tools have been developed as detailed in ‘Credits and historical remarks’ below.</p> +<p>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 and helpful tools have been developed as detailed in ‘Credits and historical remarks’ below.</p> </div> <div id="usage" class="section level2"> <h2 class="hasAnchor"> @@ -76,23 +98,25 @@ <div id="documentation" class="section level2"> <h2 class="hasAnchor"> <a href="#documentation" class="anchor"> </a>Documentation</h2> -<p>The HTML documentation is available at <a href="http://jranke.github.io/mkin">github</a> and at <a href="http://kinfit.r-forge.r-project.org/mkin_static/index.html">R-Forge</a>.</p> +<p>The HTML documentation is available at <a href="http://pkgdown.jrwb.de/mkin">jrwb.de</a>, at <a href="http://jranke.github.io/mkin">github</a> and at <a href="http://kinfit.r-forge.r-project.org/mkin_static/index.html">R-Forge</a>.</p> </div> <div id="features" class="section level2"> <h2 class="hasAnchor"> <a href="#features" class="anchor"> </a>Features</h2> -<ul><li>Highly flexible model specification using <a href="http://kinfit.r-forge.r-project.org/mkin_static/mkinmod.html"><code>mkinmod</code></a>, including equilibrium reactions and using the single first-order reversible binding (SFORB) model, which will automatically create two latent state variables for the observed variable.</li> -<li>As of version 0.9-39, fitting of several models to several datasets, optionally in parallel, is supported, see for example <a href="http://kinfit.r-forge.r-project.org/mkin_static/plot.mmkin.html"><code>plot.mmkin</code></a>.</li> -<li>Model solution (forward modelling) in the function <a href="http://kinfit.r-forge.r-project.org/mkin_static/mkinpredict.html"><code>mkinpredict</code></a> is performed either using the analytical solution for the case of parent only degradation, an eigenvalue based solution if only simple first-order (SFO) or SFORB kinetics are used in the model, or using a numeric solver from the <code>deSolve</code> package (default is <code>lsoda</code>).</li> +<ul> +<li>Highly flexible model specification using <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/mkinmod.html"><code>mkinmod</code></a>, including equilibrium reactions and using the single first-order reversible binding (SFORB) model, which will automatically create two latent state variables for the observed variable.</li> +<li>As of version 0.9-39, fitting of several models to several datasets, optionally in parallel, is supported, see for example <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/plot.mmkin.html"><code>plot.mmkin</code></a>.</li> +<li>Model solution (forward modelling) in the function <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/mkinpredict.html"><code>mkinpredict</code></a> is performed either using the analytical solution for the case of parent only degradation, an eigenvalue based solution if only simple first-order (SFO) or SFORB kinetics are used in the model, or using a numeric solver from the <code>deSolve</code> package (default is <code>lsoda</code>).</li> <li>If a C compiler is installed, the kinetic models are compiled from automatically generated C code, see<br><a href="http://kinfit.r-forge.r-project.org/mkin_static/articles/compiled_models.html">vignette <code>compiled_models</code></a>. The autogeneration of C code was inspired by the <a href="https://github.com/karlines/ccSolve"><code>ccSolve</code></a> package. Thanks to Karline Soetaert for her work on that.</li> -<li>By default, kinetic rate constants and kinetic formation fractions are transformed internally using <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/transform_odeparms.html"><code>transform_odeparms</code></a> so their estimators can more reasonably be expected to follow a normal distribution. This has the side effect that no constraints are needed in the optimisation. Thanks to René Lehmann for the nice cooperation on this, especially the isometric logration transformation that is now used for the formation fractions.</li> +<li>By default, kinetic rate constants and kinetic formation fractions are transformed internally using <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/transform_odeparms.html"><code>transform_odeparms</code></a> so their estimators can more reasonably be expected to follow a normal distribution. This has the side effect that no constraints are needed in the optimisation. Thanks to René Lehmann for the nice cooperation on this, especially the isometric logration transformation that is now used for the formation fractions.</li> <li>A side effect of this is that when parameter estimates are backtransformed to match the model definition, confidence intervals calculated from standard errors are also backtransformed to the correct scale, and will not include meaningless values like negative rate constants or formation fractions adding up to more than 1, which can not occur in a single experiment with a single defined radiolabel position.</li> <li>The usual one-sided t-test for significant difference from zero is nevertheless shown based on estimators for the untransformed parameters.</li> <li>Summary and plotting functions. The <code>summary</code> of an <code>mkinfit</code> object is in fact a full report that should give enough information to be able to approximately reproduce the fit with other tools.</li> <li>The chi-squared error level as defined in the FOCUS kinetics guidance (see below) is calculated for each observed variable.</li> <li>Iteratively reweighted least squares fitting is implemented in a similar way as in KinGUII and CAKE (see below). Simply add the argument <code>reweight = "obs"</code> to your call to <code>mkinfit</code> and a separate variance componenent for each of the observed variables will be optimised in a second stage after the primary optimisation algorithm has converged.</li> <li>When a metabolite decline phase is not described well by SFO kinetics, SFORB kinetics can be used for the metabolite.</li> -</ul></div> +</ul> +</div> <div id="gui" class="section level2"> <h2 class="hasAnchor"> <a href="#gui" class="anchor"> </a>GUI</h2> @@ -111,29 +135,42 @@ <p>Also, it was inspired by the first version of KinGUI developed by BayerCropScience, which is based on the MatLab runtime environment.</p> <p>The companion package <a href="http://kinfit.r-forge.r-project.org/kinfit_static/index.html">kinfit</a> (now deprecated) was <a href="https://r-forge.r-project.org/scm/viewvc.php?view=rev&root=kinfit&revision=2">started in 2008</a> and <a href="https://cran.r-project.org/src/contrib/Archive/kinfit/">first published</a> on CRAN on 01 May 2010.</p> <p>The first <code>mkin</code> code was <a href="https://r-forge.r-project.org/scm/viewvc.php?view=rev&root=kinfit&revision=8">published on 11 May 2010</a> and the <a href="https://cran.r-project.org/src/contrib/Archive/mkin">first CRAN version</a> on 18 May 2010.</p> -<p>In 2011, Bayer Crop Science started to distribute an R based successor to KinGUI named KinGUII whose R code is based on <code>mkin</code>, but which added, amongst other refinements, a closed source graphical user interface (GUI), iteratively reweighted least squares (IRLS) optimisation of the variance for each of the observed variables, and Markov Chain Monte Carlo (MCMC) simulation functionality, similar to what is available e.g. in the <code>FME</code> package.</p> +<p>In 2011, Bayer Crop Science started to distribute an R based successor to KinGUI named KinGUII whose R code is based on <code>mkin</code>, but which added, amongst other refinements, a closed source graphical user interface (GUI), iteratively reweighted least squares (IRLS) optimisation of the variance for each of the observed variables, and Markov Chain Monte Carlo (MCMC) simulation functionality, similar to what is available e.g. in the <code>FME</code> package.</p> <p>Somewhat in parallel, Syngenta has sponsored the development of an <code>mkin</code> and KinGUII based GUI application called CAKE, which also adds IRLS and MCMC, is more limited in the model formulation, but puts more weight on usability. CAKE is available for download from the <a href="http://showcase.tessella.com/products/cake">CAKE website</a>, where you can also find a zip archive of the R scripts derived from <code>mkin</code>, published under the GPL license.</p> <p>Finally, there is <a href="http://github.com/zhenglei-gao/KineticEval">KineticEval</a>, which contains a further development of the scripts used for KinGUII, so the different tools will hopefully be able to learn from each other in the future as well.</p> </div> <div id="development" class="section level2"> <h2 class="hasAnchor"> <a href="#development" class="anchor"> </a>Development</h2> -<p>Contributions are welcome! Your <a href="https://help.github.com/articles/fork-a-repo">mkin fork</a> is just a mouse click away… The master branch on github should always be in good shape, I implement new features in separate branches now. If you prefer subversion, project members for the <a href="http://r-forge.r-project.org/R/?group_id=615">r-forge project</a> are welcome as well. Generally, the source code of the latest CRAN version should be available there. You can also browse the source code at <a href="http://cgit.jrwb.de/mkin">cgit.jrwb.de/mkin</a>.</p> +<p>Contributions are welcome! Your <a href="https://help.github.com/articles/fork-a-repo">mkin fork</a> is just a mouse click away… The master branch on github should always be in good shape, I implement new features in separate branches now. If you prefer subversion, project members for the <a href="http://r-forge.r-project.org/R/?group_id=615">r-forge project</a> are welcome as well. Generally, the source code of the latest CRAN version should be available there. You can also browse the source code at <a href="http://cgit.jrwb.de/mkin">cgit.jrwb.de/mkin</a>.</p> </div> </div> </div> <div class="col-md-3" id="sidebar"> - <h2>Links</h2><ul class="list-unstyled"><li>Download from CRAN at <br><a href="https://cran.r-project.org/package=mkin">https://​cran.r-project.org/​package=mkin</a></li> -<li>Browse source code at <br><a href="http://github.com/jranke/mkin">http://​github.com/​jranke/​mkin</a></li> -<li>Report a bug at <br><a href="http://github.com/jranke/mkin/issues">http://​github.com/​jranke/​mkin/​issues</a></li> -</ul><h2>License</h2> + <h2>Links</h2> +<ul class="list-unstyled"> +<li>Download from CRAN at <br><a href="https://cran.r-project.org/package=mkin">https://cran.r-project.org/package=mkin</a> +</li> +<li>Browse source code at <br><a href="http://github.com/jranke/mkin">http://github.com/jranke/mkin</a> +</li> +<li>Report a bug at <br><a href="http://github.com/jranke/mkin/issues">http://github.com/jranke/mkin/issues</a> +</li> +</ul> +<h2>License</h2> <p>GPL</p> -<h2>Developers</h2><ul class="list-unstyled"><li>Johannes Ranke <br><small class="roles"> Author, maintainer, copyright holder </small> </li> +<h2>Developers</h2> +<ul class="list-unstyled"> +<li>Johannes Ranke <br><small class="roles"> Author, maintainer, copyright holder </small> </li> <li><a href="authors.html">All authors...</a></li> -</ul><html><body><h2>Dev status</h2><ul class="list-unstyled"><li><a href="https://cran.r-project.org/package=mkin"> - <img src="http://www.r-pkg.org/badges/version/mkin"></a></li> -</ul></body></html></div> +</ul> +<html><body> +<h2>Dev status</h2> +<ul class="list-unstyled"> +<li><a href="https://cran.r-project.org/package=mkin"><img src="http://www.r-pkg.org/badges/version/mkin"></a></li> +</ul> +</body></html> +</div> </div> @@ -145,6 +182,8 @@ <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p> </div> - </footer></div> + </footer> +</div> - </body></html> + </body> +</html> |