From 74ed85b07f09ea99476208749cd274a476ba4536 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Thu, 19 Jan 2017 09:27:36 +0100
Subject: Documentation updates

---
 DESCRIPTION                  | 2 +-
 R/twa.R                      | 7 +++----
 README.md                    | 5 +++--
 docs/index.html              | 2 +-
 docs/reference/sawtooth.html | 7 +++----
 man/sawtooth.Rd              | 7 +++----
 6 files changed, 14 insertions(+), 16 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index b15262c..3c96ed5 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -7,7 +7,7 @@ Authors@R: person("Johannes Ranke", email = "jranke@uni-bremen.de",
                   role = c("aut", "cre", "cph"))
 Description: Utilities for simple calculations of predicted environmental
     concentrations (PECs) and for dealing with data from some FOCUS pesticide
-    fate modelling software packages.
+    fate modelling software packages (currently only TOXSWA).
 Depends:
     R6,
     mkin
diff --git a/R/twa.R b/R/twa.R
index c936805..dd3196a 100644
--- a/R/twa.R
+++ b/R/twa.R
@@ -163,12 +163,11 @@ plot.one_box <- function(x,
 #' application pattern specified in \code{applications} is repeated \code{n}
 #' times, with an interval \code{i}.
 #' @param x A \code{\link{one_box}} object
-#' @param n The number of applications. If \code{applications} is specified, \code{n} is not used
+#' @param n The number of applications. If \code{applications} is specified, \code{n} is ignored
 #' @param i The interval between applications. If \code{applications} is specified, \code{i}
-#'   is not used
+#'   is ignored
 #' @param 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.
+#'   the corresponding amounts applied in the second column.
 #' @export
 #' @examples
 #' applications = data.frame(time = seq(0, 14, by = 7), amount = c(1, 2, 3))
diff --git a/README.md b/README.md
index 9c3d47f..3e7c869 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 # pfm
 
-The R package **pfm** provides some utilities for dealing with FOCUS pesticide fate modelling tools,
-(currently only TOXSWA cwa and out files), made available under the GNU public license.
+The R package **pfm** provides some utilities for fate modelling, including
+dealing with FOCUS pesticide fate modelling tools, (currently only TOXSWA cwa
+and out files), made available under the GNU public license.
 This means:
 
     This program is free software: you can redistribute it and/or modify it under
diff --git a/docs/index.html b/docs/index.html
index b96dfc5..db22eb0 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -46,7 +46,7 @@
     <div id="pfm" class="section level1">
 <div class="page-header"><h1 class="hasAnchor">
 <a href="#pfm" class="anchor"> </a>pfm</h1></div>
-<p>The R package <strong>pfm</strong> provides some utilities for dealing with FOCUS pesticide fate modelling tools, (currently only TOXSWA cwa and out files), made available under the GNU public license. This means:</p>
+<p>The R package <strong>pfm</strong> provides some utilities for fate modelling, including dealing with FOCUS pesticide fate modelling tools, (currently only TOXSWA cwa and out files), made available under the GNU public license. This means:</p>
 <div class="sourceCode"><pre class="sourceCode R"><code class="sourceCode r">This program is free software:<span class="st"> </span>you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free Software
 Foundation, either version <span class="dv">3</span> of the License, <span class="kw">or</span> (at your option) any later
diff --git a/docs/reference/sawtooth.html b/docs/reference/sawtooth.html
index cd3c0dc..cf33630 100644
--- a/docs/reference/sawtooth.html
+++ b/docs/reference/sawtooth.html
@@ -83,14 +83,13 @@ times, with an interval <code>i</code>.</p>
       <dt>x</dt>
       <dd>A <code><a href='one_box.html'>one_box</a></code> object</dd>
       <dt>n</dt>
-      <dd>The number of applications. If <code>applications</code> is specified, <code>n</code> is not used</dd>
+      <dd>The number of applications. If <code>applications</code> is specified, <code>n</code> is ignored</dd>
       <dt>i</dt>
       <dd>The interval between applications. If <code>applications</code> is specified, <code>i</code>
-is not used</dd>
+is ignored</dd>
       <dt>applications</dt>
       <dd>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</code> is one, the application pattern specified here is used only once.</dd>
+the corresponding amounts applied in the second column.</dd>
     </dl>
     
 
diff --git a/man/sawtooth.Rd b/man/sawtooth.Rd
index e01a74d..8eb8bea 100644
--- a/man/sawtooth.Rd
+++ b/man/sawtooth.Rd
@@ -10,14 +10,13 @@ sawtooth(x, n = 1, i = 365, applications = data.frame(time = seq(0, 0 + n
 \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{n}{The number of applications. If \code{applications} is specified, \code{n} is ignored}
 
 \item{i}{The interval between applications. If \code{applications} is specified, \code{i}
-is not used}
+is ignored}
 
 \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.}
+the corresponding amounts applied in the second column.}
 }
 \description{
 If the number of application cycles \code{n} is greater than 1, the
-- 
cgit v1.2.1