Last documentation fixes

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.
 

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{

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

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

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

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}

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