diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/index.html | 2 | ||||
| -rw-r--r-- | docs/reference/one_box.html | 5 | ||||
| -rw-r--r-- | docs/reference/plot.one_box-2.png | bin | 11641 -> 5828 bytes | |||
| -rw-r--r-- | docs/reference/plot.one_box-4.png | bin | 0 -> 10603 bytes | |||
| -rw-r--r-- | docs/reference/plot.one_box.html | 8 |
5 files changed, 11 insertions, 4 deletions
diff --git a/docs/reference/index.html b/docs/reference/index.html index e458048..8f57cd2 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -82,7 +82,7 @@ <p><a href="one_box.html">Create a time series of decline data</a></p> <ul> - <li><code><a href="one_box.html">one_box</a></code></li><li><code><a href="one_box.html">one_box.numeric</a></code></li><li><code><a href="one_box.html">one_box.mkinfit</a></code></li> + <li><code><a href="one_box.html">one_box</a></code></li><li><code><a href="one_box.html">one_box.numeric</a></code></li><li><code><a href="one_box.html">one_box.character</a></code></li><li><code><a href="one_box.html">one_box.mkinfit</a></code></li> </ul> <p><a href="plot.one_box.html">Plot time series of decline data</a></p> diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index 791528a..c8f8ad3 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -79,6 +79,9 @@ This does not create objects of type <code>ts</code>.</p> <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='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='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> @@ -93,6 +96,8 @@ decline. If x is an mkinfit object, the decline is calculated from this object</ <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> diff --git a/docs/reference/plot.one_box-2.png b/docs/reference/plot.one_box-2.png Binary files differindex 1941d44..1145f68 100644 --- a/docs/reference/plot.one_box-2.png +++ b/docs/reference/plot.one_box-2.png diff --git a/docs/reference/plot.one_box-4.png b/docs/reference/plot.one_box-4.png Binary files differnew file mode 100644 index 0000000..9664c14 --- /dev/null +++ b/docs/reference/plot.one_box-4.png diff --git a/docs/reference/plot.one_box.html b/docs/reference/plot.one_box.html index 235fb80..ec784c5 100644 --- a/docs/reference/plot.one_box.html +++ b/docs/reference/plot.one_box.html @@ -106,9 +106,11 @@ be shown if max_twa is not NULL.</dd> <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'><span class='no'>fomc_fit</span> <span class='kw'><-</span> <span class='fu'>mkinfit</span>(<span class='st'>"FOMC"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) -<span class='no'>fomc_pred</span> <span class='kw'><-</span> <span class='fu'><a href='one_box.html'>one_box</a></span>(<span class='no'>fomc_fit</span>) -<span class='fu'>plot</span>(<span class='fu'><a href='sawtooth.html'>sawtooth</a></span>(<span class='no'>fomc_pred</span>, <span class='fl'>3</span>, <span class='fl'>7</span>), <span class='kw'>max_twa</span> <span class='kw'>=</span> <span class='fl'>21</span>)</div><img src='plot.one_box-2.png' alt='' width='540' height='400' /></pre> + <pre class="examples"><div class='input'><span class='no'>dfop_pred</span> <span class='kw'><-</span> <span class='fu'><a href='one_box.html'>one_box</a></span>(<span class='st'>"DFOP"</span>, <span class='kw'>parms</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='kw'>k1</span> <span class='kw'>=</span> <span class='fl'>0.2</span>, <span class='kw'>k2</span> <span class='kw'>=</span> <span class='fl'>0.02</span>, <span class='kw'>g</span> <span class='kw'>=</span> <span class='fl'>0.7</span>)) +<span class='fu'>plot</span>(<span class='no'>dfop_pred</span>)</div><img src='plot.one_box-2.png' alt='' width='540' height='400' /><div class='input'><span class='fu'>plot</span>(<span class='fu'><a href='sawtooth.html'>sawtooth</a></span>(<span class='no'>dfop_pred</span>, <span class='fl'>3</span>, <span class='fl'>7</span>), <span class='kw'>max_twa</span> <span class='kw'>=</span> <span class='fl'>21</span>)</div><img src='plot.one_box-4.png' alt='' width='540' height='400' /><div class='input'> +<span class='co'># Use a fitted mkinfit model</span> +<span class='no'>m_2</span> <span class='kw'><-</span> <span class='fu'>mkinmod</span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'>mkinsub</span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>), <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'>mkinsub</span>(<span class='st'>"SFO"</span>))</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'><span class='no'>fit_2</span> <span class='kw'><-</span> <span class='fu'>mkinfit</span>(<span class='no'>m_2</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) +<span class='no'>pred_2_saw</span> <span class='kw'><-</span> <span class='fu'><a href='sawtooth.html'>sawtooth</a></span>(<span class='no'>pred_2</span>, <span class='fl'>2</span>, <span class='fl'>7</span>)</div><div class='output co'>#> <span class='error'>Error in as.matrix(x): Objekt 'pred_2' nicht gefunden</span></div><div class='input'><span class='fu'>plot</span>(<span class='no'>pred_2_saw</span>, <span class='kw'>max_twa</span> <span class='kw'>=</span> <span class='fl'>21</span>, <span class='kw'>max_twa_var</span> <span class='kw'>=</span> <span class='st'>"m1"</span>)</div><div class='output co'>#> <span class='error'>Error in plot(pred_2_saw, max_twa = 21, max_twa_var = "m1"): Objekt 'pred_2_saw' nicht gefunden</span></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> |
