aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2018-03-02 17:23:40 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2018-03-02 17:36:19 +0100
commit8650f26f63a64ac8b72326e2679719744ac99f07 (patch)
tree0e77a71afb34c6ca851395e8c9f4ce8daba107e8
parent3512ac1f7c41bbf94edbf73c6464da0f1d0c7160 (diff)
Use pkgdown.jrwb.de as canonical doc URL
The mkin pkgdown docs have made it to the pkgdown README :) https://github.com/r-lib/pkgdown/commit/f0ef0b58a526add2077e5899f45335a5118091f0
-rw-r--r--README.html14
-rw-r--r--README.md22
2 files changed, 18 insertions, 18 deletions
diff --git a/README.html b/README.html
index 57c4d550..c9f86c6b 100644
--- a/README.html
+++ b/README.html
@@ -136,7 +136,7 @@ $(document).ready(function () {
</div>
<div id="usage" class="section level2">
<h2>Usage</h2>
-<p>For a start, have a look a the code examples provided for <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/plot.mkinfit.html"><code>plot.mkinfit</code></a> and <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/plot.mmkin.html"><code>plot.mmkin</code></a>, and at the package vignettes <a href="http://kinfit.r-forge.r-project.org/mkin_static/articles/FOCUS_L.html"><code>FOCUS L</code></a> and <a href="http://kinfit.r-forge.r-project.org/mkin_static/articles/FOCUS_D.html"><code>FOCUS D</code></a>.</p>
+<p>For a start, have a look a the code examples provided for <a href="https://pkgdown.jrwb.de/mkin/reference/plot.mkinfit.html"><code>plot.mkinfit</code></a> and <a href="https://pkgdown.jrwb.de/mkin/reference/plot.mmkin.html"><code>plot.mmkin</code></a>, and at the package vignettes <a href="https://pkgdown.jrwb.de/mkin/articles/FOCUS_L.html"><code>FOCUS L</code></a> and <a href="https://pkgdown.jrwb.de/mkin/articles/FOCUS_D.html"><code>FOCUS D</code></a>.</p>
</div>
<div id="documentation" class="section level2">
<h2>Documentation</h2>
@@ -145,17 +145,17 @@ $(document).ready(function () {
<div id="features" class="section level2">
<h2>Features</h2>
<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 <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>Highly flexible model specification using <a href="https://pkgdown.jrwb.de/mkin/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="https://pkgdown.jrwb.de/mkin/reference/plot.mmkin.html"><code>plot.mmkin</code></a>.</li>
+<li>Model solution (forward modelling) in the function <a href="https://pkgdown.jrwb.de/mkin/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 <a href="https://pkgdown.jrwb.de/mkin/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="https://pkgdown.jrwb.de/mkin/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.method = &quot;obs&quot;</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>Iterative reweighting is also possible using the two-component error model for analytical data of <a href="http://kinfit.r-forge.r-project.org/mkin_static/reference/sigma_rl.html">Rocke and Lorenzato</a> using the argument <code>reweight.method = &quot;tc&quot;</code>.</li>
+<li>Iterative reweighting is also possible using the two-component error model for analytical data of <a href="https://pkgdown.jrwb.de/mkin/reference/sigma_rl.html">Rocke and Lorenzato</a> using the argument <code>reweight.method = &quot;tc&quot;</code>.</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>
diff --git a/README.md b/README.md
index 4ff631f6..26cdcafb 100644
--- a/README.md
+++ b/README.md
@@ -27,12 +27,12 @@ detailed guidance and helpful tools have been developed as detailed in
## Usage
For a start, have a look a the code examples provided for
-[`plot.mkinfit`](http://kinfit.r-forge.r-project.org/mkin_static/reference/plot.mkinfit.html)
+[`plot.mkinfit`](https://pkgdown.jrwb.de/mkin/reference/plot.mkinfit.html)
and
-[`plot.mmkin`](http://kinfit.r-forge.r-project.org/mkin_static/reference/plot.mmkin.html), and
+[`plot.mmkin`](https://pkgdown.jrwb.de/mkin/reference/plot.mmkin.html), and
at the package vignettes
-[`FOCUS L`](http://kinfit.r-forge.r-project.org/mkin_static/articles/FOCUS_L.html) and
-[`FOCUS D`](http://kinfit.r-forge.r-project.org/mkin_static/articles/FOCUS_D.html).
+[`FOCUS L`](https://pkgdown.jrwb.de/mkin/articles/FOCUS_L.html) and
+[`FOCUS D`](https://pkgdown.jrwb.de/mkin/articles/FOCUS_D.html).
## Documentation
@@ -44,28 +44,28 @@ and at [R-Forge](http://kinfit.r-forge.r-project.org/mkin_static/index.html).
## Features
* Highly flexible model specification using
- [`mkinmod`](http://kinfit.r-forge.r-project.org/mkin_static/reference/mkinmod.html),
+ [`mkinmod`](https://pkgdown.jrwb.de/mkin/reference/mkinmod.html),
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.
* As of version 0.9-39, fitting of several models to several datasets, optionally in
parallel, is supported, see for example
- [`plot.mmkin`](http://kinfit.r-forge.r-project.org/mkin_static/reference/plot.mmkin.html).
+ [`plot.mmkin`](https://pkgdown.jrwb.de/mkin/reference/plot.mmkin.html).
* Model solution (forward modelling) in the function
- [`mkinpredict`](http://kinfit.r-forge.r-project.org/mkin_static/reference/mkinpredict.html)
+ [`mkinpredict`](https://pkgdown.jrwb.de/mkin/reference/mkinpredict.html)
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 `deSolve` package (default is `lsoda`).
* If a C compiler is installed, the kinetic models are compiled from automatically
generated C code, see
- [vignette `compiled_models`](http://kinfit.r-forge.r-project.org/mkin_static/articles/compiled_models.html).
+ [vignette `compiled_models`](https://pkgdown.jrwb.de/mkin/articles/compiled_models.html).
The autogeneration of C code was
inspired by the [`ccSolve`](https://github.com/karlines/ccSolve) package. Thanks
to Karline Soetaert for her work on that.
* By default, kinetic rate constants and kinetic formation fractions are
transformed internally using
- [`transform_odeparms`](http://kinfit.r-forge.r-project.org/mkin_static/reference/transform_odeparms.html)
+ [`transform_odeparms`](https://pkgdown.jrwb.de/mkin/reference/transform_odeparms.html)
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
@@ -90,8 +90,8 @@ and at [R-Forge](http://kinfit.r-forge.r-project.org/mkin_static/index.html).
componenent for each of the observed variables will be optimised
in a second stage after the primary optimisation algorithm has converged.
* Iterative reweighting is also possible using the two-component error model
- for analytical data of
- [Rocke and Lorenzato](http://kinfit.r-forge.r-project.org/mkin_static/reference/sigma_rl.html)
+ for analytical data of
+ [Rocke and Lorenzato](https://pkgdown.jrwb.de/mkin/reference/sigma_rl.html)
using the argument `reweight.method = "tc"`.
* When a metabolite decline phase is not described well by SFO kinetics,
SFORB kinetics can be used for the metabolite.

Contact - Imprint