aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/calplot.lm.html
blob: 7eda066e4ef526cead66c67bfebe6d2387607744 (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>Plot calibration graphs from univariate linear models — calplot • 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="Plot calibration graphs from univariate linear models — calplot" />

<meta property="og:description" content="Produce graphics of calibration data, the fitted model as well
  as confidence, and, for unweighted regression, prediction bands." />
<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.1.37.9001</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../reference/index.html">Functions and data</a>
</li>
<li>
  <a href="../articles/chemCal.pdf">Short manual (pdf)</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>Plot calibration graphs from univariate linear models</h1>
    
    <div class="hidden name"><code>calplot.lm.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>Produce graphics of calibration data, the fitted model as well
  as confidence, and, for unweighted regression, prediction bands.</p>
    
    </div>

    <pre class="usage"><span class='fu'>calplot</span>(<span class='no'>object</span>, <span class='kw'>xlim</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"auto"</span>, <span class='st'>"auto"</span>), <span class='kw'>ylim</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"auto"</span>, <span class='st'>"auto"</span>),
    <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"Concentration"</span>, <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"Response"</span>, <span class='kw'>alpha</span><span class='kw'>=</span><span class='fl'>0.05</span>, <span class='kw'>varfunc</span> <span class='kw'>=</span> <span class='kw'>NULL</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>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>xlim</th>
      <td><p>The limits of the plot on the x axis.</p></td>
    </tr>
    <tr>
      <th>ylim</th>
      <td><p>The limits of the plot on the y axis.</p></td>
    </tr>
    <tr>
      <th>xlab</th>
      <td><p>The label of the x axis.</p></td>
    </tr>
    <tr>
      <th>ylab</th>
      <td><p>The label of the y axis.</p></td>
    </tr>
    <tr>
      <th>alpha</th>
      <td><p>The error tolerance level for the confidence and prediction bands. Note that this 
    includes both tails of the Gaussian distribution, unlike the alpha and beta parameters
    used in <code>lod</code> (see note below).</p></td>
    </tr>
    <tr>
      <th>varfunc</th>
      <td><p>The variance function for generating the weights in the model.
    Currently, this argument is ignored (see note below).</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>A plot of the calibration data, of your fitted model as well as lines showing
  the confidence limits. Prediction limits are only shown for models from
  unweighted regression.</p>
    
    <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>

    <p>Prediction bands for models from weighted linear regression require weights
  for the data, for which responses should be predicted. Prediction intervals
  using weights e.g. from a variance function are currently not supported by
  the internally used function <code>predict.lm</code>, therefore,
  <code>calplot</code> does not draw prediction bands for such models.</p>  
<p>It is possible to compare the <code>calplot</code> prediction bands with the
  <code>lod</code> values if the <code>lod()</code> alpha and beta parameters are
  half the value of the <code>calplot()</code> alpha parameter.</p>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'><span class='fu'>data</span>(<span class='no'>massart97ex3</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'>massart97ex3</span>)
<span class='fu'>calplot</span>(<span class='no'>m</span>)</div><div class='img'><img src='calplot.lm-1.png' alt='' width='700' height='433' /></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="#examples">Examples</a></li>
    </ul>

    <h2>Author</h2>
    
  Johannes Ranke 
  <a href='mailto:jranke@uni-bremen.de'>jranke@uni-bremen.de</a> 
  <a href='http://www.uft.uni-bremen.de/chemie/ranke'>http://www.uft.uni-bremen.de/chemie/ranke</a>

  </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