aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/inverse.predict.html
blob: 1207ab578004e92465fe562d279419ff95c59db3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><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>Predict x from y for a linear calibration — inverse.predict • chemCal</title><!-- jquery --><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.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/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.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" 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"><script src="../pkgdown.js"></script><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.  The
calculation method was taken from Massart et al. (1997). In particular,
Equations 8.26 and 8.28 were combined in order to yield a general treatment
of inverse prediction for univariate linear models, taking into account
weights that have been used to create the linear model, and at the same 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."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></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 data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">chemCal</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.2.3.9000</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../articles/chemCal.html">Get started</a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="https://github.com/jranke/chemCal/" class="external-link">
    <span class="fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Predict x from y for a linear calibration</h1>
    <small class="dont-index">Source: <a href="https://github.com/jranke/chemCal/blob/HEAD/R/inverse.predict.lm.R" class="external-link"><code>R/inverse.predict.lm.R</code></a></small>
    <div class="hidden name"><code>inverse.predict.Rd</code></div>
    </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.  The
calculation method was taken from Massart et al. (1997). In particular,
Equations 8.26 and 8.28 were combined in order to yield a general treatment
of inverse prediction for univariate linear models, taking into account
weights that have been used to create the linear model, and at the same 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>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">inverse.predict</span><span class="op">(</span>
  <span class="va">object</span>,
  <span class="va">newdata</span>,
  <span class="va">...</span>,
  ws <span class="op">=</span> <span class="st">"auto"</span>,
  alpha <span class="op">=</span> <span class="fl">0.05</span>,
  var.s <span class="op">=</span> <span class="st">"auto"</span>
<span class="op">)</span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>object</dt>
<dd><p>A univariate model object of class <code><a href="https://rdrr.io/r/stats/lm.html" class="external-link">lm</a></code> or
<code><a href="https://rdrr.io/pkg/MASS/man/rlm.html" class="external-link">rlm</a></code> with model formula <code>y ~ x</code> or <code>y ~ x -
1</code>.</p></dd>
<dt>newdata</dt>
<dd><p>A vector of observed y values for one sample.</p></dd>
<dt>...</dt>
<dd><p>Placeholder for further arguments that might be needed by
future implementations.</p></dd>
<dt>ws</dt>
<dd><p>The weight attributed to the sample. This argument is obligatory
if <code>object</code> has weights.</p></dd>
<dt>alpha</dt>
<dd><p>The error tolerance level for the confidence interval to be
reported.</p></dd>
<dt>var.s</dt>
<dd><p>The estimated variance of the sample measurements. The default
is to take the residual standard error from the calibration and to adjust it
using <code>ws</code>, if applicable. This means that <code>var.s</code> overrides
<code>ws</code>.</p></dd>
</dl></div>
    <div id="value">
    <h2>Value</h2>
    <p>A list containing the predicted x value, its standard error and a
confidence interval.</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>This is an implementation of Equation (8.28) in the Handbook of Chemometrics
and Qualimetrics, Part A, Massart et al (1997), page 200, validated with
Example 8 on the same page, extended as specified in the package vignette</p>
    </div>
    <div id="note">
    <h2>Note</h2>
    <p>The function was validated with examples 7 and 8 from Massart et al.
(1997).  Note that the behaviour of inverse.predict changed with chemCal
version 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>
    </div>
    <div id="references">
    <h2>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>
    </div>

    <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"># This is example 7 from Chapter 8 in Massart et al. (1997)</span></span>
<span class="r-in"><span class="va">m</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/stats/lm.html" class="external-link">lm</a></span><span class="op">(</span><span class="va">y</span> <span class="op">~</span> <span class="va">x</span>, data <span class="op">=</span> <span class="va">massart97ex1</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">inverse.predict</span><span class="op">(</span><span class="va">m</span>, <span class="fl">15</span><span class="op">)</span>        <span class="co">#  6.1 +- 4.9</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Prediction</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 6.09381</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Standard Error`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 1.767278</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Confidence</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 4.906751</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Confidence Limits`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1]  1.187059 11.000561</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"><span class="fu">inverse.predict</span><span class="op">(</span><span class="va">m</span>, <span class="fl">90</span><span class="op">)</span>        <span class="co"># 43.9 +- 4.9</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Prediction</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 43.93983</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Standard Error`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 1.767747</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Confidence</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 4.908053</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Confidence Limits`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 39.03178 48.84788</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"><span class="fu">inverse.predict</span><span class="op">(</span><span class="va">m</span>, <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="fl">90</span>,<span class="fl">5</span><span class="op">)</span><span class="op">)</span> <span class="co"># 43.9 +- 3.2</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Prediction</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 43.93983</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Standard Error`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 1.141204</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Confidence</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 3.168489</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Confidence Limits`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 40.77134 47.10832</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># For reproducing the results for replicate standard measurements in example 8,</span></span>
<span class="r-in"><span class="co"># we need to do the calibration on the means when using chemCal &gt; 0.2</span></span>
<span class="r-in"><span class="va">weights</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/with.html" class="external-link">with</a></span><span class="op">(</span><span class="va">massart97ex3</span>, <span class="op">{</span></span>
<span class="r-in">  <span class="va">yx</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/split.html" class="external-link">split</a></span><span class="op">(</span><span class="va">y</span>, <span class="va">x</span><span class="op">)</span></span>
<span class="r-in">  <span class="va">ybar</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">sapply</a></span><span class="op">(</span><span class="va">yx</span>, <span class="va">mean</span><span class="op">)</span></span>
<span class="r-in">  <span class="va">s</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">sapply</a></span><span class="op">(</span><span class="va">yx</span>, <span class="va">sd</span><span class="op">)</span>, digits <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span>
<span class="r-in">  <span class="va">w</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="fl">1</span> <span class="op">/</span> <span class="op">(</span><span class="va">s</span><span class="op">^</span><span class="fl">2</span><span class="op">)</span>, digits <span class="op">=</span> <span class="fl">3</span><span class="op">)</span></span>
<span class="r-in"><span class="op">}</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">massart97ex3.means</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/stats/aggregate.html" class="external-link">aggregate</a></span><span class="op">(</span><span class="va">y</span> <span class="op">~</span> <span class="va">x</span>, <span class="va">massart97ex3</span>, <span class="va">mean</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">m3.means</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/stats/lm.html" class="external-link">lm</a></span><span class="op">(</span><span class="va">y</span> <span class="op">~</span> <span class="va">x</span>, w <span class="op">=</span> <span class="va">weights</span>, data <span class="op">=</span> <span class="va">massart97ex3.means</span><span class="op">)</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="fu">inverse.predict</span><span class="op">(</span><span class="va">m3.means</span>, <span class="fl">15</span>, ws <span class="op">=</span> <span class="fl">1.67</span><span class="op">)</span>  <span class="co"># 5.9 +- 2.5</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Prediction</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 5.865367</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Standard Error`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 0.8926109</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Confidence</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 2.478285</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Confidence Limits`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 3.387082 8.343652</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"><span class="fu">inverse.predict</span><span class="op">(</span><span class="va">m3.means</span>, <span class="fl">90</span>, ws <span class="op">=</span> <span class="fl">0.145</span><span class="op">)</span> <span class="co"># 44.1 +- 7.9</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Prediction</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 44.06025</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Standard Error`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 2.829162</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $Confidence</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 7.855012</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> $`Confidence Limits`</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 36.20523 51.91526</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
<span class="r-in"></span>
<span class="r-in"></span>
</code></pre></div>
    </div>
  </div>
  <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></p><p>Developed by Johannes Ranke.</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.2.</p>
</div>

      </footer></div>

  


  

  </body></html>

Contact - Imprint