From a5ed89863c0ef4e9b3296c00146e6528c53678fd Mon Sep 17 00:00:00 2001
From: Sebastian Henz <sebastian.henz@ufz.de>
Date: Mon, 18 May 2020 18:32:29 +0200
Subject: [PATCH] Last documentation fixes
---
NEWS.md | 2 +-
R/data.R | 7 ++++---
R/multi_tox.R | 8 ++++----
R/plot_ecxsys.R | 2 +-
man/multi_tox.Rd | 8 ++++----
man/multiple_stress.Rd | 7 ++++---
man/plot_ecxsys.Rd | 2 +-
7 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/NEWS.md b/NEWS.md
index 98888b4..1422585 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -12,7 +12,7 @@
* Fixed some errors in the documentation and improved the examples.
## New
-* Exporte function `log10_ticks()` for calculating tick mark labels and positions on a base 10 logarithmic axis.
+* Export function `log10_ticks()` for calculating tick mark labels and positions on a base 10 logarithmic axis.
* Add example data set `multiple_stress` for use with `multi_tox()`.
* Various minor changes to prepare for CRAN submission.
diff --git a/R/data.R b/R/data.R
index bd310d9..eb8c1d8 100644
--- a/R/data.R
+++ b/R/data.R
@@ -22,9 +22,10 @@
#' Survival of Daphnia magna exposed to multiple stressors
#'
-#' Individuals of Daphnia magna were exposed to combinations of food stress and
-#' multiple concentrations of the pesticides esfenvalerate and prochloraz.
-#' The survival was recorded at 21 days after contamination.
+#' A data set of mixture toxicity experiments. Individuals of Daphnia magna were
+#' exposed to combinations of food stress and multiple concentrations of the
+#' pesticides esfenvalerate and prochloraz. The survival was recorded at 21 days
+#' after contamination.
#'
#' @format A data frame with 58 rows and 4 variables:
#' \describe{
diff --git a/R/multi_tox.R b/R/multi_tox.R
index 17b80a1..97ae971 100644
--- a/R/multi_tox.R
+++ b/R/multi_tox.R
@@ -25,11 +25,11 @@
#'
#' The predictions are symmetric, i.e. it does not matter which of the toxicant
#' models is a or b as long as the concentration arguments are supplied in the
-#' same order. See the example below.
+#' same order.
#'
-#' This method is only suitable for experiments without environmental stress.
-#' Any environmental stress supplied as arguments to \code{\link{ecxsys}} in
-#' \code{model_a} or \code{model_b} is ignored.
+#' This method is only suitable for experiments without or with low
+#' environmental stress. Any environmental stress supplied as arguments to
+#' \code{\link{ecxsys}} in \code{model_a} or \code{model_b} is ignored.
#'
#' @param model_a,model_b The ecxsys models of the toxicants.
#' @param concentration_a,concentration_b The concentrations of the toxicants in
diff --git a/R/plot_ecxsys.R b/R/plot_ecxsys.R
index f0d9c0f..6d1ec9e 100644
--- a/R/plot_ecxsys.R
+++ b/R/plot_ecxsys.R
@@ -26,7 +26,7 @@
#'
#' @name plot_ecxsys
#'
-#' @param model The list returned from \code{\link{ecxsys}}.
+#' @param model The object returned from \code{\link{ecxsys}}.
#' @param which A vector of names to plot. Allowed are the column names of the
#' \code{model$curves} data frame. There is also
#' \code{"survival_tox_observed"} and \code{"survival_tox_env_observed"} for
diff --git a/man/multi_tox.Rd b/man/multi_tox.Rd
index b9c3db5..7abbb9f 100644
--- a/man/multi_tox.Rd
+++ b/man/multi_tox.Rd
@@ -41,11 +41,11 @@ details.
\details{
The predictions are symmetric, i.e. it does not matter which of the toxicant
models is a or b as long as the concentration arguments are supplied in the
-same order. See the example below.
+same order.
-This method is only suitable for experiments without environmental stress.
-Any environmental stress supplied as arguments to \code{\link{ecxsys}} in
-\code{model_a} or \code{model_b} is ignored.
+This method is only suitable for experiments without or with low
+environmental stress. Any environmental stress supplied as arguments to
+\code{\link{ecxsys}} in \code{model_a} or \code{model_b} is ignored.
}
\examples{
# Using a data set which is included in this package. See ?multiple_stress
diff --git a/man/multiple_stress.Rd b/man/multiple_stress.Rd
index 685d8ae..8667622 100644
--- a/man/multiple_stress.Rd
+++ b/man/multiple_stress.Rd
@@ -26,8 +26,9 @@ A data frame with 58 rows and 4 variables:
multiple_stress
}
\description{
-Individuals of Daphnia magna were exposed to combinations of food stress and
-multiple concentrations of the pesticides esfenvalerate and prochloraz.
-The survival was recorded at 21 days after contamination.
+A data set of mixture toxicity experiments. Individuals of Daphnia magna were
+exposed to combinations of food stress and multiple concentrations of the
+pesticides esfenvalerate and prochloraz. The survival was recorded at 21 days
+after contamination.
}
\keyword{datasets}
diff --git a/man/plot_ecxsys.Rd b/man/plot_ecxsys.Rd
index 0cb3187..d5c09b0 100644
--- a/man/plot_ecxsys.Rd
+++ b/man/plot_ecxsys.Rd
@@ -26,7 +26,7 @@ plot_survival(
)
}
\arguments{
-\item{model}{The list returned from \code{\link{ecxsys}}.}
+\item{model}{The object returned from \code{\link{ecxsys}}.}
\item{which}{A vector of names to plot. Allowed are the column names of the
\code{model$curves} data frame. There is also
--
GitLab