aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2018-01-30 11:06:33 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2018-01-30 11:20:55 +0100
commit3147a8c1ec1aa81097bd9897b33b703ae3a5d20f (patch)
treebd863539e7307ce24360d9c47a65614bc2c07938
parentbd234377b7fa2ef056544a9299478b265d18d89f (diff)
Improve documentation of Rocke and Lorenzato model
Static documentation except articles rebuilt by pkgdown
-rw-r--r--README.html1
-rw-r--r--docs/reference/sigma_rl.html4
-rw-r--r--man/sigma_rl.Rd5
3 files changed, 6 insertions, 4 deletions
diff --git a/README.html b/README.html
index f4999a38..b3ba4ce1 100644
--- a/README.html
+++ b/README.html
@@ -153,6 +153,7 @@ $(document).ready(function () {
<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>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/docs/reference/sigma_rl.html b/docs/reference/sigma_rl.html
index 36f2a0c1..b7c93961 100644
--- a/docs/reference/sigma_rl.html
+++ b/docs/reference/sigma_rl.html
@@ -103,8 +103,8 @@
<p>Function describing the standard deviation of the measurement error
- in dependence of the measured value:</p>
-<p>\(sigma = sqrt(sigma_low^2 + y^2 * rsd_high^2)\)</p>
+ in dependence of the measured value \(y\):</p>
+<p>$$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$</p>
<pre class="usage"><span class='fu'>sigma_rl</span>(<span class='no'>y</span>, <span class='no'>sigma_low</span>, <span class='no'>rsd_high</span>)</pre>
diff --git a/man/sigma_rl.Rd b/man/sigma_rl.Rd
index d1c22a77..0b5d6f3c 100644
--- a/man/sigma_rl.Rd
+++ b/man/sigma_rl.Rd
@@ -3,9 +3,10 @@
\title{ Two component error model of Rocke and Lorenzato}
\description{
Function describing the standard deviation of the measurement error
- in dependence of the measured value:
+ in dependence of the measured value \eqn{y}:
- \eqn{sigma = sqrt(sigma_low^2 + y^2 * rsd_high^2)}
+ \deqn{\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}}{%
+ sigma = sqrt(sigma_low^2 + y^2 * rsd_high^2)}
}
\usage{
sigma_rl(y, sigma_low, rsd_high)

Contact - Imprint