diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2017-01-19 09:20:22 +0100 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2017-01-19 09:20:22 +0100 |
| commit | a6d61c06d573574cf574ed893cc13808a9e8b785 (patch) | |
| tree | 6ff3587e1445ed57861f22cb7074257238366a0f /docs/reference/one_box.html | |
| parent | b8ac1393b9e1bef8c48b26b790cf5759ccd69fed (diff) | |
Fix order of arguments to one_box, correct docs
Diffstat (limited to 'docs/reference/one_box.html')
| -rw-r--r-- | docs/reference/one_box.html | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index c8f8ad3..698f887 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -74,28 +74,28 @@ This does not create objects of type <code>ts</code>.</p> - <pre><span class='fu'>one_box</span>(<span class='no'>x</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='no'>...</span>) + <pre><span class='fu'>one_box</span>(<span class='no'>x</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'>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='no'>...</span>) +<span class='fu'>one_box</span>(<span class='no'>x</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 character</span> -<span class='fu'>one_box</span>(<span class='no'>x</span>, <span class='no'>parms</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='no'>...</span>) +<span class='fu'>one_box</span>(<span class='no'>x</span>, <span class='no'>parms</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 mkinfit</span> -<span class='fu'>one_box</span>(<span class='no'>x</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='no'>...</span>)</pre> +<span class='fu'>one_box</span>(<span class='no'>x</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 decline. If x is an mkinfit object, the decline is calculated from this object</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>...</dt> - <dd>Further arguments passed to methods</dd> <dt>parms</dt> <dd>A named numeric vector containing the model parameters</dd> </dl> |