aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-19 09:20:22 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-19 09:20:22 +0100
commita6d61c06d573574cf574ed893cc13808a9e8b785 (patch)
tree6ff3587e1445ed57861f22cb7074257238366a0f /man
parentb8ac1393b9e1bef8c48b26b790cf5759ccd69fed (diff)
Fix order of arguments to one_box, correct docs
Diffstat (limited to 'man')
-rw-r--r--man/one_box.Rd12
-rw-r--r--man/plot.one_box.Rd1
2 files changed, 7 insertions, 6 deletions
diff --git a/man/one_box.Rd b/man/one_box.Rd
index dc524a8..5a46142 100644
--- a/man/one_box.Rd
+++ b/man/one_box.Rd
@@ -7,24 +7,24 @@
\alias{one_box.mkinfit}
\title{Create a time series of decline data}
\usage{
-one_box(x, t_end = 100, res = 0.01, ...)
+one_box(x, ..., t_end = 100, res = 0.01)
-\method{one_box}{numeric}(x, t_end = 100, res = 0.01, ...)
+\method{one_box}{numeric}(x, ..., t_end = 100, res = 0.01)
-\method{one_box}{character}(x, parms, t_end = 100, res = 0.01, ...)
+\method{one_box}{character}(x, parms, ..., t_end = 100, res = 0.01)
-\method{one_box}{mkinfit}(x, t_end = 100, res = 0.01, ...)
+\method{one_box}{mkinfit}(x, ..., t_end = 100, res = 0.01)
}
\arguments{
\item{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}
+\item{...}{Further arguments passed to methods}
+
\item{t_end}{End of the time series}
\item{res}{Resolution of the time series}
-\item{...}{Further arguments passed to methods}
-
\item{parms}{A named numeric vector containing the model parameters}
}
\description{
diff --git a/man/plot.one_box.Rd b/man/plot.one_box.Rd
index e2c9a42..69ee908 100644
--- a/man/plot.one_box.Rd
+++ b/man/plot.one_box.Rd
@@ -38,6 +38,7 @@ plot(sawtooth(dfop_pred, 3, 7), max_twa = 21)
# Use a fitted mkinfit model
m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
+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")
}

Contact - Imprint