One box time series and twa values

- one_box() creates decline time series from mkinfit objects or simply
  from a half-life
- sawtooth() generates sawtooth curves for arbitrary application
  patterns and decline models
- twa() calculates moving window averages
- max_twa() gives their maxima and
- plot.one_box() can plot series generated by one_box() or sawtooth(),
  optionally adding a greay rectangle to illustrate the maximum moving
  window time weighted average

1 files changed, 35 insertions, 0 deletions

diff --git a/man/plot.one_box.Rd b/man/plot.one_box.Rd
new file mode 100644
index 0000000..7d30bd2
--- /dev/null
+++ b/man/plot.one_box.Rd
@@ -0,0 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/twa.R
+\name{plot.one_box}
+\alias{plot.one_box}
+\title{Plot time series of decline data}
+\usage{
+\method{plot}{one_box}(x, xlim = range(time(x)), ylim = c(0, max(x)),
+  xlab = "Time", ylab = "Fraction of initial", max_twa = NULL,
+  max_twa_var = dimnames(x)[[2]][1], ...)
+}
+\arguments{
+\item{x}{The object of type \code{\link{one_box}} to be plotted}
+
+\item{xlim}{Limits for the x axis}
+
+\item{ylim}{Limits for the y axis}
+
+\item{xlab}{Label for the x axis}
+
+\item{ylab}{Label for the y axis}
+
+\item{max_twa}{If a numeric value is given, the maximum time weighted
+average concentration(s) is/are shown in the graph.}
+
+\item{max_twa_var}{Variable for which the maximum time weighted average should
+be shown if max_twa is not NULL.}
+
+\item{...}{Further arguments passed to methods}
+}
+\description{
+Plot time series of decline data
+}
+\examples{
+plot(sawtooth(one_box(10), 3, 7), max_twa = 21)
+}