diff options
Diffstat (limited to 'docs/reference/ilr.html')
| -rw-r--r-- | docs/reference/ilr.html | 69 |
1 files changed, 39 insertions, 30 deletions
diff --git a/docs/reference/ilr.html b/docs/reference/ilr.html index 58ae56b0..7c3a2e33 100644 --- a/docs/reference/ilr.html +++ b/docs/reference/ilr.html @@ -18,7 +18,7 @@ transformations."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">mkin</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.0</span> </span> </div> @@ -45,19 +45,25 @@ transformations."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax <a href="../articles/web_only/dimethenamid_2018.html">Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models</a> </li> <li> - <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> + <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a> </li> <li> <a href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a> </li> <li> + <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> + </li> + <li> <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a> </li> <li> <a href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a> </li> <li> - <a href="../articles/web_only/benchmarks.html">Some benchmark timings</a> + <a href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a> + </li> + <li> + <a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a> </li> </ul></li> <li> @@ -89,9 +95,9 @@ transformations.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">ilr</span><span class="op">(</span><span class="va">x</span><span class="op">)</span> - -<span class="fu">invilr</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ilr</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">invilr</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> @@ -99,10 +105,13 @@ transformations.</p> <dl><dt>x</dt> <dd><p>A numeric vector. Naturally, the forward transformation is only sensible for vectors with all elements being greater than zero.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>The result of the forward or backward transformation. The returned + + +<p>The result of the forward or backward transformation. The returned components always sum to 1 for the case of the inverse log-ratio transformation.</p> </div> @@ -123,39 +132,39 @@ Compositional Data Using Robust Methods. Math Geosci 40 233-248</p> <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"><span class="co"># Order matters</span></span> -<span class="r-in"><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.1</span>, <span class="fl">1</span>, <span class="fl">10</span><span class="op">)</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span><span class="co"># Order matters</span></span></span> +<span class="r-in"><span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.1</span>, <span class="fl">1</span>, <span class="fl">10</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] -1.628174 -2.820079</span> -<span class="r-in"><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">10</span>, <span class="fl">1</span>, <span class="fl">0.1</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">10</span>, <span class="fl">1</span>, <span class="fl">0.1</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 1.628174 2.820079</span> -<span class="r-in"><span class="co"># Equal entries give ilr transformations with zeros as elements</span></span> -<span class="r-in"><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">3</span>, <span class="fl">3</span>, <span class="fl">3</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="co"># Equal entries give ilr transformations with zeros as elements</span></span></span> +<span class="r-in"><span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">3</span>, <span class="fl">3</span>, <span class="fl">3</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 0 0</span> -<span class="r-in"><span class="co"># Almost equal entries give small numbers</span></span> -<span class="r-in"><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.3</span>, <span class="fl">0.4</span>, <span class="fl">0.3</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="co"># Almost equal entries give small numbers</span></span></span> +<span class="r-in"><span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.3</span>, <span class="fl">0.4</span>, <span class="fl">0.3</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] -0.2034219 0.1174457</span> -<span class="r-in"><span class="co"># Only the ratio between the numbers counts, not their sum</span></span> -<span class="r-in"><span class="fu">invilr</span><span class="op">(</span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.7</span>, <span class="fl">0.29</span>, <span class="fl">0.01</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="co"># Only the ratio between the numbers counts, not their sum</span></span></span> +<span class="r-in"><span><span class="fu">invilr</span><span class="op">(</span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.7</span>, <span class="fl">0.29</span>, <span class="fl">0.01</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 0.70 0.29 0.01</span> -<span class="r-in"><span class="fu">invilr</span><span class="op">(</span><span class="fu">ilr</span><span class="op">(</span><span class="fl">2.1</span> <span class="op">*</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.7</span>, <span class="fl">0.29</span>, <span class="fl">0.01</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">invilr</span><span class="op">(</span><span class="fu">ilr</span><span class="op">(</span><span class="fl">2.1</span> <span class="op">*</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.7</span>, <span class="fl">0.29</span>, <span class="fl">0.01</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 0.70 0.29 0.01</span> -<span class="r-in"><span class="co"># Inverse transformation of larger numbers gives unequal elements</span></span> -<span class="r-in"><span class="fu">invilr</span><span class="op">(</span><span class="op">-</span><span class="fl">10</span><span class="op">)</span></span> +<span class="r-in"><span><span class="co"># Inverse transformation of larger numbers gives unequal elements</span></span></span> +<span class="r-in"><span><span class="fu">invilr</span><span class="op">(</span><span class="op">-</span><span class="fl">10</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 7.213536e-07 9.999993e-01</span> -<span class="r-in"><span class="fu">invilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="op">-</span><span class="fl">10</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="fu">invilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="op">-</span><span class="fl">10</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 7.207415e-07 9.991507e-01 8.486044e-04</span> -<span class="r-in"><span class="co"># The sum of the elements of the inverse ilr is 1</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/sum.html" class="external-link">sum</a></span><span class="op">(</span><span class="fu">invilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="op">-</span><span class="fl">10</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span> +<span class="r-in"><span><span class="co"># The sum of the elements of the inverse ilr is 1</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/sum.html" class="external-link">sum</a></span><span class="op">(</span><span class="fu">invilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="op">-</span><span class="fl">10</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 1</span> -<span class="r-in"><span class="co"># This is why we do not need all elements of the inverse transformation to go back:</span></span> -<span class="r-in"><span class="va">a</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.1</span>, <span class="fl">0.3</span>, <span class="fl">0.5</span><span class="op">)</span></span> -<span class="r-in"><span class="va">b</span> <span class="op"><-</span> <span class="fu">invilr</span><span class="op">(</span><span class="va">a</span><span class="op">)</span></span> -<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/length.html" class="external-link">length</a></span><span class="op">(</span><span class="va">b</span><span class="op">)</span> <span class="co"># Four elements</span></span> +<span class="r-in"><span><span class="co"># This is why we do not need all elements of the inverse transformation to go back:</span></span></span> +<span class="r-in"><span><span class="va">a</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.1</span>, <span class="fl">0.3</span>, <span class="fl">0.5</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">b</span> <span class="op"><-</span> <span class="fu">invilr</span><span class="op">(</span><span class="va">a</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/length.html" class="external-link">length</a></span><span class="op">(</span><span class="va">b</span><span class="op">)</span> <span class="co"># Four elements</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 4</span> -<span class="r-in"><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">b</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">3</span><span class="op">]</span>, <span class="fl">1</span> <span class="op">-</span> <span class="fu"><a href="https://rdrr.io/r/base/sum.html" class="external-link">sum</a></span><span class="op">(</span><span class="va">b</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">3</span><span class="op">]</span><span class="op">)</span><span class="op">)</span><span class="op">)</span> <span class="co"># Gives c(0.1, 0.3, 0.5)</span></span> +<span class="r-in"><span><span class="fu">ilr</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">b</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">3</span><span class="op">]</span>, <span class="fl">1</span> <span class="op">-</span> <span class="fu"><a href="https://rdrr.io/r/base/sum.html" class="external-link">sum</a></span><span class="op">(</span><span class="va">b</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">3</span><span class="op">]</span><span class="op">)</span><span class="op">)</span><span class="op">)</span> <span class="co"># Gives c(0.1, 0.3, 0.5)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> [1] 0.1 0.3 0.5</span> -<span class="r-in"></span> +<span class="r-in"><span></span></span> </code></pre></div> </div> </div> @@ -170,7 +179,7 @@ Compositional Data Using Robust Methods. Math Geosci 40 233-248</p> </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p> </div> </footer></div> |