aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/inverse.predict.html
blob: b1071545540bcbc52784d0deedc0e77610f29fed (plain) (tree)



















                                                                                                                                                                                                                      

                                                                                                                                                                                                              
 


                                                                                                                                                                                         

                                             
                                     


 
                                                                                                    
 










                                                                                                                      


 
                
                                                                                                  




                                                                               

 












                                                                                                         

                                                               
                                                                                                                             
             
          
 


                                                      



                                          

     






                                                    





                                              
      






                                
                 


                                                      

                                                                  

          
                                 











                                                                                    
          
 
                                                                

                                       
                                                                                               




                                                                   
                                                                                          






















                                                                                           

                                                                            


                                       







                                                                                   




                                                                                    









                                                                                                                                

































                                                                                                                                                                                                                                                                        





































                                                                                                                                                                                                                                                                                                                                        























                                                         
                                                                         




               

  

         
 
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
  <head>
  <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://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" 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>

<!-- 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." />
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
    <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">
        <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="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.2.1</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<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">
        
      </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>
    
    <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>

    <pre class="usage">inverse.predict(object, newdata, &#8230;,
  ws, alpha=0.05, var.s = "auto")</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>lm</code> or 
    <code><a href='http://www.rdocumentation.org/packages/MASS/topics/rlm'>rlm</a></code> 
    with model formula <code>y ~ x</code> or <code>y ~ x - 1</code>.</p></td>
    </tr>
    <tr>
      <th>newdata</th>
      <td><p>A vector of observed y values for one sample.</p></td>
    </tr>
    <tr>
      <th>&#8230;</th>
      <td><p>Placeholder for further arguments that might be needed by 
    future implementations.</p></td>
    </tr>
    <tr>
      <th>ws</th>
      <td><p>The weight attributed to the sample. This argument is obligatory
    if <code>object</code> has weights.</p></td>
    </tr>
    <tr>
      <th>alpha</th>
      <td><p>The error tolerance level for the confidence interval to be reported.</p></td>
    </tr>
    <tr>
      <th>var.s</th>
      <td><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></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). 
  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>
    
    <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'>lm</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; 
#&gt; $`Standard Error`
#&gt; [1] 1.767278
#&gt; 
#&gt; $Confidence
#&gt; [1] 4.906751
#&gt; 
#&gt; $`Confidence Limits`
#&gt; [1]  1.187059 11.000561
#&gt; </div><div class='input'><span class='fu'>inverse.predict</span>(<span class='no'>m</span>, <span class='fl'>90</span>)        <span class='co'># 43.9 +- 4.9</span></div><div class='output co'>#&gt; $Prediction
#&gt; [1] 43.93983
#&gt; 
#&gt; $`Standard Error`
#&gt; [1] 1.767747
#&gt; 
#&gt; $Confidence
#&gt; [1] 4.908053
#&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'>rep</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`
#&gt; [1] 1.141204
#&gt; 
#&gt; $Confidence
#&gt; [1] 3.168489
#&gt; 
#&gt; $`Confidence Limits`
#&gt; [1] 40.77134 47.10832
#&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'>with</span>(<span class='no'>massart97ex3</span>, {
  <span class='no'>yx</span> <span class='kw'>&lt;-</span> <span class='fu'>split</span>(<span class='no'>y</span>, <span class='no'>x</span>)
  <span class='no'>ybar</span> <span class='kw'>&lt;-</span> <span class='fu'>sapply</span>(<span class='no'>yx</span>, <span class='no'>mean</span>)
  <span class='no'>s</span> <span class='kw'>&lt;-</span> <span class='fu'>round</span>(<span class='fu'>sapply</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'>round</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'>aggregate</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'>lm</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
#&gt; 
#&gt; $`Standard Error`
#&gt; [1] 0.8926109
#&gt; 
#&gt; $Confidence
#&gt; [1] 2.478285
#&gt; 
#&gt; $`Confidence Limits`
#&gt; [1] 3.387082 8.343652
#&gt; </div><div class='input'><span class='fu'>inverse.predict</span>(<span class='no'>m3.means</span>, <span class='fl'>90</span>, <span class='kw'>ws</span> <span class='kw'>=</span> <span class='fl'>0.145</span>) <span class='co'># 44.1 +- 7.9</span></div><div class='output co'>#&gt; $Prediction
#&gt; [1] 44.06025
#&gt; 
#&gt; $`Standard Error`
#&gt; [1] 2.829162
#&gt; 
#&gt; $Confidence
#&gt; [1] 7.855012
#&gt; 
#&gt; $`Confidence Limits`
#&gt; [1] 36.20523 51.91526
#&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>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  

  </body>
</html>

Contact - Imprint