From a5503d3e26408f7308a7bf4da617205b93d17422 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Thu, 10 Oct 2019 09:21:46 +0200
Subject: Fix documentation for set_nd

---
 man/set_nd.Rd | 19 +++++++------------
 1 file changed, 7 insertions(+), 12 deletions(-)

(limited to 'man')

diff --git a/man/set_nd.Rd b/man/set_nd.Rd
index 8c6003c..bdbc6d2 100644
--- a/man/set_nd.Rd
+++ b/man/set_nd.Rd
@@ -3,16 +3,7 @@
 \name{set_nd}
 \alias{set_nd}
 \alias{set_nd_focus}
-\title{Set non-detects in residue series without replicates
-Sets non-detects directly before or directly after detects to NA. Values between
-lod and loq are set to their mean value if an loq is specified.
-If 'time_zero' is set to TRUE, the residue series is assumed to start with time
-zero, and non-detects at time zero are set to 'time_zero_nd_value'. For the
-set_nd_focus variant, this is zero, otherwise this argument has NA as default
-value.
-If stopping after the first non-detection is requested, as in in the FOCUS
-variant of the function, an loq has to be specified in order to decide
-if any later detections are above the loq.}
+\title{Set non-detects in residue series without replicates}
 \usage{
 set_nd(r, lod, loq = NA, time_zero = TRUE, time_zero_nd_value = NA,
   stop_after_first_nondetect = FALSE)
@@ -36,7 +27,6 @@ stop after the first non-detection is to be applied}
 \item{stop_after_first_nondetect}{Should we really stop after the first non-detection?}
 }
 \description{
-Set non-detects in residue series without replicates
 Sets non-detects directly before or directly after detects to NA. Values between
 lod and loq are set to their mean value if an loq is specified.
 If 'time_zero' is set to TRUE, the residue series is assumed to start with time
@@ -49,10 +39,13 @@ if any later detections are above the loq.
 }
 \section{Functions}{
 \itemize{
+\item \code{set_nd}: Set non-detects in residues series
+
 \item \code{set_nd_focus}: Set non-detects in residues series according to FOCUS rules
 }}
 
 \examples{
+# FOCUS (2014) p. 75/76 and 131/132
 parent_1 <- c(.12, .09, .05, .03, "nd", "nd", "nd", "nd", "nd", "nd")
 set_nd(parent_1, 0.02)
 parent_2 <- c(.12, .09, .05, .03, "nd", "nd", .03, "nd", "nd", "nd")
@@ -65,5 +58,7 @@ metabolite <- c("nd", "nd", "nd", 0.03, 0.06, 0.10, 0.11, 0.10, 0.09, 0.05, 0.03
 set_nd(metabolite, 0.02)
 }
 \references{
-FOCUS (2014) p. 75, 76, 131, 132
+FOCUS (2014) Generic Guidance for Estimating Persistence and Degradation
+  Kinetics from Environmental Fate Studies on Pesticides in EU Registration, Version 1.1, 
+  18 December 2014, p. 251
 }
-- 
cgit v1.2.1