aboutsummaryrefslogblamecommitdiff
path: root/inst/web/mkinresplot.html
blob: ec82518b96d6e8f8e069dad60d2f50518a8302ad (plain) (tree)
1
2
3
4
5



                          
                                            






























                                                                                      
                                                    
























































































































                                                                                                                                                                                                                                                                                               
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
<title>mkinresplot. mkin 0.9.41.9000</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="
  Johannes Ranke
">

<link href="css/bootstrap.css" rel="stylesheet">
<link href="css/bootstrap-responsive.css" rel="stylesheet">
<link href="css/highlight.css" rel="stylesheet">
<link href="css/staticdocs.css" rel="stylesheet">

<!--[if lt IE 9]>
  <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->

<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    tex2jax: {
      inlineMath: [ ['$','$'], ["\\(","\\)"] ],
      processEscapes: true
    }
  });
</script>
<script type="text/javascript"
  src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
  </head>

  <body>
    <div class="navbar">
  <div class="navbar-inner">
    <div class="container">
      <a class="brand" href="#">mkin 0.9.41.9000</a>
      <div class="nav">
        <ul class="nav">
          <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>
        </ul>
      </div>
    </div>
  </div>
</div>

    <div class="container">
      <header>
        
      </header>
      
      <h1>
  Function to plot residuals stored in an mkin object
</h1>

<div class="row">
  <div class="span8">
    <h2>Usage</h2>
    <pre><div>mkinresplot(object,  obs_vars&nbsp;=&nbsp;names(object$mkinmod$map), xlim&nbsp;=&nbsp;c(0, 1.1 * max(object$data$time)), xlab&nbsp;=&nbsp;"Time", ylab&nbsp;=&nbsp;"Residual",  maxabs&nbsp;=&nbsp;"auto", legend&nbsp;=&nbsp;TRUE, lpos&nbsp;=&nbsp;"topright", ...)</div></pre>
    
    <h2>Arguments</h2>
    <dl>
      <dt>object</dt>
      <dd>
    A fit represented in an <code><a href='mkinfit.html'>mkinfit</a></code> object.
</dd>
      <dt>obs_vars</dt>
      <dd>
    A character vector of names of the observed variables for which residuals
    should be plotted. Defaults to all observed variables in the model
</dd>
      <dt>xlim</dt>
      <dd>
    plot range in x direction.
  </dd>
      <dt>xlab</dt>
      <dd>
    Label for the x axis. Defaults to "Time [days]".
</dd>
      <dt>ylab</dt>
      <dd>
    Label for the y axis. Defaults to "Residual [% of applied radioactivity]".
</dd>
      <dt>maxabs</dt>
      <dd>
    Maximum absolute value of the residuals. This is used for the scaling of
    the y axis and defaults to "auto".
</dd>
      <dt>legend</dt>
      <dd>
    Should a legend be plotted? Defaults to "TRUE".
</dd>
      <dt>lpos</dt>
      <dd> 
    Where should the legend be placed? Default is "topright". Will be passed on to
		<code><a href='http://www.inside-r.org/r-doc/graphics/legend'>legend</a></code>. </dd>
      <dt>...</dt>
      <dd>
   further arguments passed to <code><a href='http://www.inside-r.org/r-doc/graphics/plot'>plot</a></code>.
</dd>
    </dl>
    
    <div class="Description">
      <h2>Description</h2>

      <p>This function plots the residuals for the specified subset of the 
  observed variables from an mkinfit object. A combined plot of the fitted
  model and the residuals can be obtained using <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code>
  using the argument <code>show_residuals = TRUE</code>.</p>
  
    </div>

    <div class="Value">
      <h2>Value</h2>

      <p><dl>
  Nothing is returned by this function, as it is called for its side effect, namely to produce a plot.
</dl></p>
  
    </div>
    
    <h2 id="examples">Examples</h2>
    <pre class="examples"><div class='input'>model &lt;- mkinmod(parent = mkinsub(&quot;SFO&quot;, &quot;m1&quot;), m1 = mkinsub(&quot;SFO&quot;))
</div>
<strong class='message'>Successfully compiled differential equation model from auto-generated C code.</strong>
<div class='input'>fit &lt;- mkinfit(model, FOCUS_2006_D, quiet = TRUE)
mkinresplot(fit, &quot;m1&quot;)
</div>
<p><img src='mkinresplot-4.png' alt='' width='540' height='400' /></p></pre>
  </div>
  <div class="span4">
    <!-- <ul>
      <li>mkinresplot</li>
    </ul>
    <ul>
      <li> hplot </li>
    </ul> -->
      
    <h2>See also</h2>
    
 <code><a href='mkinplot.html'>mkinplot</a></code>, for a way to plot the data and the fitted lines of the
 mkinfit object.  
    
    <h2>Author</h2>
    
  Johannes Ranke

    
  </div>
</div>
      
      <footer>
      <p class="pull-right"><a href="#">Back to top</a></p>
<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="http://twitter.github.com/bootstrap">bootstrap</a>.</p>
      </footer>
    </div>
  </body>
</html>

Contact - Imprint