From a1d9f93138c2cfed92a683e37e72c737d52b7ad7 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Wed, 18 Jan 2017 19:58:13 +0100
Subject: 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
---
 man/sawtooth.Rd | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 man/sawtooth.Rd

(limited to 'man/sawtooth.Rd')

diff --git a/man/sawtooth.Rd b/man/sawtooth.Rd
new file mode 100644
index 0000000..4576c8b
--- /dev/null
+++ b/man/sawtooth.Rd
@@ -0,0 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/twa.R
+\name{sawtooth}
+\alias{sawtooth}
+\title{Create decline time series for multiple applications}
+\usage{
+sawtooth(x, n = 1, i = 365, applications = data.frame(time = seq(0, 0 + n
+  * i, length.out = n), amount = 1))
+}
+\arguments{
+\item{x}{A \code{\link{one_box}} object}
+
+\item{n}{The number of applications. If \code{applications} is specified, \code{n} is not used}
+
+\item{i}{The interval between applications. If \code{applications} is specified, \code{i} 
+is not used}
+
+\item{applications}{A data frame holding the application times in the first column and
+the corresponding amounts applied in the second column for each application cycle.
+If \code{n} is one, the application pattern specified here is used only once.}
+}
+\description{
+If the number of application cycles \code{n} is greater than 1, the
+application pattern specified in \code{applications} is repeated \code{n}
+times, with an interval \code{i}.
+}
+\examples{
+applications = data.frame(time = seq(0, 14, by = 7), amount = c(1, 2, 3))
+pred <- one_box(10)
+plot(sawtooth(pred, applications = applications))
+
+m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
+fit_2 <- mkinfit(m_2, FOCUS_2006_D)
+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")
+
+max_twa(pred_2_saw)
+}
-- 
cgit v1.2.1