From a6d61c06d573574cf574ed893cc13808a9e8b785 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 19 Jan 2017 09:20:22 +0100 Subject: Fix order of arguments to one_box, correct docs --- docs/reference/one_box.html | 12 ++++++------ docs/reference/plot.one_box-8.png | Bin 0 -> 13603 bytes docs/reference/plot.one_box.html | 4 +++- 3 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 docs/reference/plot.one_box-8.png (limited to 'docs/reference') 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 ts.

- 
one_box(x, t_end = 100, res = 0.01, ...)
+    
one_box(x, ..., t_end = 100, res = 0.01)
 
 # S3 method for numeric
-one_box(x, t_end = 100, res = 0.01, ...)
+one_box(x, ..., t_end = 100, res = 0.01)
 
 # S3 method for character
-one_box(x, parms, t_end = 100, res = 0.01, ...)
+one_box(x, parms, ..., t_end = 100, res = 0.01)
 
 # S3 method for mkinfit
-one_box(x, t_end = 100, res = 0.01, ...)

+one_box(x, ..., t_end = 100, res = 0.01)

Arguments

x
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
+
...
+
Further arguments passed to methods
t_end
End of the time series
res
Resolution of the time series
-
...
-
Further arguments passed to methods
parms
A named numeric vector containing the model parameters
diff --git a/docs/reference/plot.one_box-8.png b/docs/reference/plot.one_box-8.png new file mode 100644 index 0000000..161ecb4 Binary files /dev/null and b/docs/reference/plot.one_box-8.png differ diff --git a/docs/reference/plot.one_box.html b/docs/reference/plot.one_box.html index ec784c5..d43c415 100644 --- a/docs/reference/plot.one_box.html +++ b/docs/reference/plot.one_box.html @@ -110,7 +110,9 @@ be shown if max_twa is not NULL. plot(dfop_pred)
plot(sawtooth(dfop_pred, 3, 7), max_twa = 21)
# Use a fitted mkinfit model m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
#> Successfully compiled differential equation model from auto-generated C code.
fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE) -pred_2_saw <- sawtooth(pred_2, 2, 7)
#> Error in as.matrix(x): Objekt 'pred_2' nicht gefunden
plot(pred_2_saw, max_twa = 21, max_twa_var = "m1")
#> Error in plot(pred_2_saw, max_twa = 21, max_twa_var = "m1"): Objekt 'pred_2_saw' nicht gefunden
+pred_2 <- one_box(fit_2) +pred_2_saw <- sawtooth(pred_2, 2, 7) +plot(pred_2_saw, max_twa = 21, max_twa_var = "m1")