Update the documentation, closes #27.

R/ecxsys.R

@@ -28,8 +28,11 @@
 
 #' ECx-SyS
 #'
-#' The ECx-SyS model for modeling concentration-survival relationships with
-#' hormesis.
+#' ECx-SyS is a model for tri-phasic concentration-response relationships where
+#' hormetic and subhormetic effects are observed at low concentrations. It
+#' expands the Stress Addition Model (SAM) by introducing system stress (SyS)
+#' which is negatively correlated with toxicant stress. See the publication for
+#' details.
 #'
 #' It is advised to complete the curve down to zero for optimal prediction.
 #' Therefore \code{survival_tox_observed} in the highest concentration should be

R/multi_tox.R

@@ -17,10 +17,11 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 
-#' Predict the survival of a mixture of two toxicants
+#' Predict the survival of binary toxicant mixtures
 #'
-#' Given the ECx-SyS models of two toxicants this method predicts the survival
-#' of different mixtures.
+#' The Multi-TOX model predicts the effects of binary toxicant mixtures taking
+#' into account three-phasic concentration-response relationships. See the
+#' publication for details.
 #'
 #' The predictions are symmetric, i.e. it does not matter which of the toxicant
 #' models is 1 or 2 as long as the concentration arguments are supplied in the

README.md

 # stressaddition
 This is the R implementation of the tri-phasic concentration-response model introduced in
-[Liess, M., Henz, S. & Knillmann, S. Predicting low-concentration effects of pesticides. Sci Rep 9, 15248 (2019).](https://doi.org/10.1038/s41598-019-51645-4)
-It allows modeling of ecotoxicological experiments where the response shows signs of a hormesis effect.
+[Liess, M., Henz, S. & Knillmann, S. Predicting low-concentration effects of pesticides. Sci Rep 9, 15248 (2019)](https://doi.org/10.1038/s41598-019-51645-4). It allows modeling of ecotoxicological experiments where the response shows signs of a hormesis effect.
+
+The EC<sub>x-SyS</sub> and Multi-TOX models from this package are also available as part of the [Indicate app](http://www.systemecology.eu/indicate) which offers a graphical user interface.
 
 ## Installation
 Stressaddition is not on CRAN. You can install the most recent stable version from GitLab using the remotes package:

man/ecxsys.Rd

@@ -69,8 +69,11 @@ A list (of class ecxsys) containing many different objects of which
   }
 }
 \description{
-The ECx-SyS model for modeling concentration-survival relationships with
-hormesis.
+ECx-SyS is a model for tri-phasic concentration-response relationships where
+hormetic and subhormetic effects are observed at low concentrations. It
+expands the Stress Addition Model (SAM) by introducing system stress (SyS)
+which is negatively correlated with toxicant stress. See the publication for
+details.
 }
 \details{
 It is advised to complete the curve down to zero for optimal prediction.

man/multi_tox.Rd

@@ -2,7 +2,7 @@
 % Please edit documentation in R/multi_tox.R
 \name{multi_tox}
 \alias{multi_tox}
-\title{Predict the survival of a mixture of two toxicants}
+\title{Predict the survival of binary toxicant mixtures}
 \usage{
 multi_tox(
   model_a,
@@ -34,8 +34,9 @@ A data frame with columns of the supplied concentrations and the
   corresponding mixture survival and stresses.
 }
 \description{
-Given the ECx-SyS models of two toxicants this method predicts the survival
-of different mixtures.
+The Multi-TOX model predicts the effects of binary toxicant mixtures taking
+into account three-phasic concentration-response relationships. See the
+publication for details.
 }
 \details{
 The predictions are symmetric, i.e. it does not matter which of the toxicant