diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2017-05-16 15:43:50 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2017-05-16 15:43:50 +0200 |
| commit | 36036b5901223591e7e21e8b73d8cd1fb034f4cb (patch) | |
| tree | ed8e764778aa2e94b785263d18d7d8e3dfe4e785 /docs/reference/one_box.html | |
| parent | d042f8f06b313e8595087587455daac73d84f17b (diff) | |
Finish the Step 1 calculator including tests
Some cleaning up. PELMO facilities do not currently work at my end,
as I have no working wine installation on this computer
Diffstat (limited to 'docs/reference/one_box.html')
| -rw-r--r-- | docs/reference/one_box.html | 53 |
1 files changed, 34 insertions, 19 deletions
diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index 800ca66..931e722 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -25,12 +25,14 @@ <script src="../pkgdown.js"></script> <!-- mathjax --> -<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> +<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> @@ -73,7 +75,7 @@ <p>Create a time series of decline data</p> - <pre><span class='fu'>one_box</span>(<span class='no'>x</span>, <span class='no'>ini</span>, <span class='no'>...</span>, <span class='kw'>t_end</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>res</span> <span class='kw'>=</span> <span class='fl'>0.01</span>) + <pre class="usage"><span class='fu'>one_box</span>(<span class='no'>x</span>, <span class='no'>ini</span>, <span class='no'>...</span>, <span class='kw'>t_end</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>res</span> <span class='kw'>=</span> <span class='fl'>0.01</span>) <span class='co'># S3 method for numeric</span> <span class='fu'>one_box</span>(<span class='no'>x</span>, <span class='kw'>ini</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>...</span>, <span class='kw'>t_end</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>res</span> <span class='kw'>=</span> <span class='fl'>0.01</span>) @@ -86,28 +88,41 @@ <span class='fu'>one_box</span>(<span class='no'>x</span>, <span class='kw'>ini</span> <span class='kw'>=</span> <span class='st'>"model"</span>, <span class='no'>...</span>, <span class='kw'>t_end</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>res</span> <span class='kw'>=</span> <span class='fl'>0.01</span>)</pre> <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2> - <dl class="dl-horizontal"> - <dt>x</dt> - <dd>When numeric, this is the half-life to be used for an exponential + <table class="ref-arguments"> + <colgroup><col class="name" /><col class="desc" /></colgroup> + <tr> + <th>x</th> + <td><p>When numeric, this is the half-life to be used for an exponential decline. When a character string specifying a parent decline model is given e.g. <code>FOMC</code>, <code>parms</code> must contain the corresponding paramters. If x is an <code>mkinfit</code> object, the decline is calculated from this -object.</dd> - <dt>ini</dt> - <dd>The initial amount. If x is an <code>mkinfit</code> object, and -ini is 'model', the fitted initial concentrations are used. Otherwise, ini +object.</p></td> + </tr> + <tr> + <th>ini</th> + <td><p>The initial amount. If x is an <code>mkinfit</code> object, and +ini is 'model', the fitted initial concentrations are used. Otherwise, ini must be numeric. If it has length one, it is used for the parent and initial values of metabolites are zero, otherwise, it must give values for -all observed variables.</dd> - <dt>...</dt> - <dd>Further arguments passed to methods</dd> - <dt>t_end</dt> - <dd>End of the time series</dd> - <dt>res</dt> - <dd>Resolution of the time series</dd> - <dt>parms</dt> - <dd>A named numeric vector containing the model parameters</dd> - </dl> +all observed variables.</p></td> + </tr> + <tr> + <th>...</th> + <td><p>Further arguments passed to methods</p></td> + </tr> + <tr> + <th>t_end</th> + <td><p>End of the time series</p></td> + </tr> + <tr> + <th>res</th> + <td><p>Resolution of the time series</p></td> + </tr> + <tr> + <th>parms</th> + <td><p>A named numeric vector containing the model parameters</p></td> + </tr> + </table> <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> |