From 3a579d87820ccbec514f1be5eb090e874fd87eec Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Tue, 22 Dec 2015 19:32:54 +0100
Subject: EFSA 2015 tier 1 PEC soil, clean up, add static docs

---
 pkg/R/endpoint.R | 20 +++++++++-----------
 1 file changed, 9 insertions(+), 11 deletions(-)

(limited to 'pkg/R/endpoint.R')

diff --git a/pkg/R/endpoint.R b/pkg/R/endpoint.R
index 6cc253a..fbe9f43 100644
--- a/pkg/R/endpoint.R
+++ b/pkg/R/endpoint.R
@@ -4,6 +4,11 @@
 #' and can hold a list of information loaded from a chemical yaml file in their
 #' chyaml field. Such information is extracted and optionally aggregated by
 #' this function.
+#' 
+#' The functions \code{soil_*} are functions to extract soil specific endpoints.
+#' For the Freundlich exponent, the capital letter \code{N} is used in order to
+#' facilitate dealing with such data in R. In pesticide fate modelling, this
+#' exponent is often called 1/n.
 #'
 #' @import chents
 #' @export
@@ -48,9 +53,8 @@ endpoint <- function(chent,
   else return(signif(aggregator(as.numeric(values)), signif))
 }
 
-#' Obtain soil DT50
-#'
 #' @inheritParams endpoint
+#' @rdname endpoint
 #' @export
 soil_DT50 <- function(chent, aggregator = geomean, signif = 3, 
                       lab_field = "laboratory", value = "DT50ref",
@@ -61,9 +65,8 @@ soil_DT50 <- function(chent, aggregator = geomean, signif = 3,
   return(ep)
 }
 
-#' Obtain soil Kfoc
-#'
 #' @inheritParams endpoint
+#' @rdname endpoint
 #' @export
 soil_Kfoc <- function(chent, aggregator = geomean, signif = 3, 
                       value = "Kfoc", raw = FALSE) {
@@ -72,12 +75,8 @@ soil_Kfoc <- function(chent, aggregator = geomean, signif = 3,
   return(ep)
 }
 
-#' Obtain soil Freundlich exponent
-#'
-#' In pesticide fate modelling, this exponent is often called 1/n. Here, in 
-#' order to facilitate dealing with such data in R, it is called N.
-#'
 #' @inheritParams endpoint
+#' @rdname endpoint
 #' @export
 soil_N <- function(chent, aggregator = mean, signif = 3, raw = FALSE) {
   ep <- endpoint(chent, medium = "soil", type = "sorption", 
@@ -85,9 +84,8 @@ soil_N <- function(chent, aggregator = mean, signif = 3, raw = FALSE) {
   return(ep)
 }
 
-#' Obtain soil sorption data
-#'
 #' @inheritParams endpoint
+#' @rdname endpoint
 #' @param values The values to be returned
 #' @param aggregators A named vector of aggregator functions to be used
 #' @export
-- 
cgit v1.2.1