aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/inverse.predict.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2020-05-20 08:44:47 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2020-05-20 08:44:47 +0200
commit43d58935483e0d9dda7a74c029e7d7d2adad9ed7 (patch)
treee09b6827e30e7f83fcefe76b2d3b4b78a6a4a5c9 /docs/reference/inverse.predict.html
parent58083418f158d9b1d69caef6f7b7b6e4b5772913 (diff)
Static documentation rebuilt by pkgdown::build_site()
Diffstat (limited to 'docs/reference/inverse.predict.html')
-rw-r--r--docs/reference/inverse.predict.html101
1 files changed, 52 insertions, 49 deletions
diff --git a/docs/reference/inverse.predict.html b/docs/reference/inverse.predict.html
index 4ea9a75..3c4c867 100644
--- a/docs/reference/inverse.predict.html
+++ b/docs/reference/inverse.predict.html
@@ -8,21 +8,29 @@
<title>Predict x from y for a linear calibration — inverse.predict • chemCal</title>
+
<!-- jquery -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
-<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
+
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
+
+<!-- bootstrap-toc -->
+<link rel="stylesheet" href="../bootstrap-toc.css">
+<script src="../bootstrap-toc.js"></script>
<!-- Font Awesome icons -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
<!-- clipboard.js -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
-<!-- sticky kit -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
+<!-- headroom.js -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
@@ -30,8 +38,8 @@
-<meta property="og:title" content="Predict x from y for a linear calibration — inverse.predict" />
+<meta property="og:title" content="Predict x from y for a linear calibration — inverse.predict" />
<meta property="og:description" content="This function predicts x values using a univariate linear model that has been
generated for the purpose of calibrating a measurement method. Prediction
intervals are given at the specified confidence level.
@@ -42,7 +50,7 @@
time providing the possibility to specify a precision in sample measurements
differing from the precision in standard samples used for the calibration.
This is elaborated in the package vignette." />
-<meta name="twitter:card" content="summary" />
+
@@ -56,9 +64,10 @@
<![endif]-->
+
</head>
- <body>
+ <body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
@@ -80,7 +89,7 @@
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
- <span class="fa fa-home fa-lg"></span>
+ <span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
@@ -94,9 +103,13 @@
<a href="../news/index.html">Changelog</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
-
+ <li>
+ <a href="http://github.com/jranke/chemCal/">
+ <span class="fab fa fab fa-github fa-lg"></span>
+
+ </a>
+</li>
</ul>
</div><!--/.nav-collapse -->
@@ -104,6 +117,7 @@
</div><!--/.navbar -->
+
</header>
<div class="row">
@@ -115,7 +129,6 @@
</div>
<div class="ref-description">
-
<p>This function predicts x values using a univariate linear model that has been
generated for the purpose of calibrating a measurement method. Prediction
intervals are given at the specified confidence level.
@@ -126,19 +139,18 @@
time providing the possibility to specify a precision in sample measurements
differing from the precision in standard samples used for the calibration.
This is elaborated in the package vignette.</p>
-
</div>
- <pre class="usage">inverse.predict(object, newdata, &#8230;,
- ws, alpha=0.05, var.s = "auto")</pre>
-
+ <pre class="usage"><span class='fu'>inverse.predict</span>(<span class='no'>object</span>, <span class='no'>newdata</span>, <span class='no'>...</span>,
+ <span class='no'>ws</span>, <span class='kw'>alpha</span><span class='kw'>=</span><span class='fl'>0.05</span>, <span class='kw'>var.s</span> <span class='kw'>=</span> <span class='st'>"auto"</span>)</pre>
+
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>object</th>
- <td><p>A univariate model object of class <code><a href='https://www.rdocumentation.org/packages/stats/topics/lm'>lm</a></code> or
- <code><a href='https://www.rdocumentation.org/packages/MASS/topics/rlm'>rlm</a></code>
+ <td><p>A univariate model object of class <code><a href='https://rdrr.io/r/stats/lm.html'>lm</a></code> or
+ <code><a href='https://rdrr.io/pkg/MASS/man/rlm.html'>rlm</a></code>
with model formula <code>y ~ x</code> or <code>y ~ x - 1</code>.</p></td>
</tr>
<tr>
@@ -146,7 +158,7 @@
<td><p>A vector of observed y values for one sample.</p></td>
</tr>
<tr>
- <th>&#8230;</th>
+ <th>...</th>
<td><p>Placeholder for further arguments that might be needed by
future implementations.</p></td>
</tr>
@@ -167,12 +179,11 @@
overrides <code>ws</code>.</p></td>
</tr>
</table>
-
+
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>A list containing the predicted x value, its standard error and a
confidence interval.</p>
-
<h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>
<p>The function was validated with examples 7 and 8 from Massart et al. (1997).
@@ -180,17 +191,15 @@
0.2.1. Confidence intervals for x values obtained from calibrations with
replicate measurements did not take the variation about the means into account.
Please refer to the vignette for details.</p>
-
<h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2>
<p>Massart, L.M, Vandenginste, B.G.M., Buydens, L.M.C., De Jong, S., Lewi, P.J.,
Smeyers-Verbeke, J. (1997) Handbook of Chemometrics and Qualimetrics: Part A,
p. 200</p>
-
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='co'># This is example 7 from Chapter 8 in Massart et al. (1997)</span>
-<span class='no'>m</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/lm'>lm</a></span>(<span class='no'>y</span> ~ <span class='no'>x</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='no'>massart97ex1</span>)
+<span class='no'>m</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/stats/lm.html'>lm</a></span>(<span class='no'>y</span> ~ <span class='no'>x</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='no'>massart97ex1</span>)
<span class='fu'>inverse.predict</span>(<span class='no'>m</span>, <span class='fl'>15</span>) <span class='co'># 6.1 +- 4.9</span></div><div class='output co'>#&gt; $Prediction
#&gt; [1] 6.09381
#&gt;
@@ -213,7 +222,7 @@
#&gt;
#&gt; $`Confidence Limits`
#&gt; [1] 39.03178 48.84788
-#&gt; </div><div class='input'><span class='fu'>inverse.predict</span>(<span class='no'>m</span>, <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/rep'>rep</a></span>(<span class='fl'>90</span>,<span class='fl'>5</span>)) <span class='co'># 43.9 +- 3.2</span></div><div class='output co'>#&gt; $Prediction
+#&gt; </div><div class='input'><span class='fu'>inverse.predict</span>(<span class='no'>m</span>, <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>90</span>,<span class='fl'>5</span>)) <span class='co'># 43.9 +- 3.2</span></div><div class='output co'>#&gt; $Prediction
#&gt; [1] 43.93983
#&gt;
#&gt; $`Standard Error`
@@ -227,16 +236,16 @@
#&gt; </div><div class='input'>
<span class='co'># For reproducing the results for replicate standard measurements in example 8,</span>
<span class='co'># we need to do the calibration on the means when using chemCal &gt; 0.2</span>
-<span class='no'>weights</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/with'>with</a></span>(<span class='no'>massart97ex3</span>, {
- <span class='no'>yx</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/split'>split</a></span>(<span class='no'>y</span>, <span class='no'>x</span>)
- <span class='no'>ybar</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/lapply'>sapply</a></span>(<span class='no'>yx</span>, <span class='no'>mean</span>)
- <span class='no'>s</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/Round'>round</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/lapply'>sapply</a></span>(<span class='no'>yx</span>, <span class='no'>sd</span>), <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>2</span>)
- <span class='no'>w</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/Round'>round</a></span>(<span class='fl'>1</span> / (<span class='no'>s</span>^<span class='fl'>2</span>), <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>3</span>)
+<span class='no'>weights</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/with.html'>with</a></span>(<span class='no'>massart97ex3</span>, {
+ <span class='no'>yx</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/split.html'>split</a></span>(<span class='no'>y</span>, <span class='no'>x</span>)
+ <span class='no'>ybar</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/lapply.html'>sapply</a></span>(<span class='no'>yx</span>, <span class='no'>mean</span>)
+ <span class='no'>s</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/Round.html'>round</a></span>(<span class='fu'><a href='https://rdrr.io/r/base/lapply.html'>sapply</a></span>(<span class='no'>yx</span>, <span class='no'>sd</span>), <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>2</span>)
+ <span class='no'>w</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/Round.html'>round</a></span>(<span class='fl'>1</span> / (<span class='no'>s</span>^<span class='fl'>2</span>), <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>3</span>)
})
-<span class='no'>massart97ex3.means</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/aggregate'>aggregate</a></span>(<span class='no'>y</span> ~ <span class='no'>x</span>, <span class='no'>massart97ex3</span>, <span class='no'>mean</span>)
+<span class='no'>massart97ex3.means</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/stats/aggregate.html'>aggregate</a></span>(<span class='no'>y</span> ~ <span class='no'>x</span>, <span class='no'>massart97ex3</span>, <span class='no'>mean</span>)
-<span class='no'>m3.means</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/lm'>lm</a></span>(<span class='no'>y</span> ~ <span class='no'>x</span>, <span class='kw'>w</span> <span class='kw'>=</span> <span class='no'>weights</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='no'>massart97ex3.means</span>)
+<span class='no'>m3.means</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/stats/lm.html'>lm</a></span>(<span class='no'>y</span> ~ <span class='no'>x</span>, <span class='kw'>w</span> <span class='kw'>=</span> <span class='no'>weights</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='no'>massart97ex3.means</span>)
<span class='fu'>inverse.predict</span>(<span class='no'>m3.means</span>, <span class='fl'>15</span>, <span class='kw'>ws</span> <span class='kw'>=</span> <span class='fl'>1.67</span>) <span class='co'># 5.9 +- 2.5</span></div><div class='output co'>#&gt; $Prediction
#&gt; [1] 5.865367
@@ -263,36 +272,30 @@
#&gt; </div><div class='input'>
</div></pre>
</div>
- <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
- <h2>Contents</h2>
- <ul class="nav nav-pills nav-stacked">
- <li><a href="#arguments">Arguments</a></li>
-
- <li><a href="#value">Value</a></li>
-
- <li><a href="#note">Note</a></li>
-
- <li><a href="#references">References</a></li>
-
- <li><a href="#examples">Examples</a></li>
- </ul>
-
+ <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
+ <nav id="toc" data-toggle="toc" class="sticky-top">
+ <h2 data-toc-skip>Contents</h2>
+ </nav>
</div>
</div>
+
<footer>
<div class="copyright">
<p>Developed by Johannes Ranke.</p>
</div>
<div class="pkgdown">
- <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
+ <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
</div>
+
</footer>
</div>
+
</body>
</html>
+

Contact - Imprint