Merge branch 'develop' into 'master'

v2.7.0 - return stresses of predict_mixture()

See merge request !29

DESCRIPTION

 Package: stressaddition
 Type: Package
 Title: Modeling Tri-Phasic Concentration-Response Relationships
-Version: 2.6.0
-Date: 2020-04-07
+Version: 2.7.0
+Date: 2020-04-17
 Authors@R: c(person("Sebastian", 
                     "Henz", 
                     role = c("aut", "cre"), 

NEWS.md

+# stressaddition 2.7.0
+
+* Fixed some spelling mistakes.
+* `predict_mixture()` now also returns the various stresses.
+
 # stressaddition 2.6.0
 
 * The `curves` data frame in the output of `ecxsys()` now contains a column with the concentrations which are used for the plot functions in this package. This is useful for generating a nicer concentration axis.

R/ecxsys.R

@@ -28,7 +28,7 @@
 
 #' ECx-SyS
 #'
-#' The ECx-SyS model for modeling concentration-effect relationships whith
+#' The ECx-SyS model for modeling concentration-effect relationships with
 #' hormesis.
 #'
 #' It is advised to complete the curve down to zero for optimal prediction.

R/predict_mixture.R

@@ -41,7 +41,7 @@
 #'   this should be 100 (the default).
 #'
 #' @return A data frame with columns of the supplied concentrations and the
-#'   corresponding mixture effects.
+#'   corresponding mixture effects and stresses.
 #'
 #' @examples toxicant_a  <- ecxsys(
 #'     concentration = c(0, 0.05, 0.5, 5, 30),
@@ -132,9 +132,16 @@ predict_mixture <- function(model_a,
     stress_total <- stress_tox_total + sys_total
     effect <- stress_to_effect(stress_total) * effect_max
 
-    # Setting row.names to NULL to prevent row names when one of the
-    # concentrations is a single number.
-    data.frame(concentration_a, concentration_b, effect, row.names = NULL)
+    data.frame(
+        concentration_a = concentration_a,
+        concentration_b = concentration_b,
+        effect = effect,
+        stress_tox_sam = stress_tox_sam,
+        stress_tox_ca = stress_tox_ca,
+        stress_tox = stress_tox_total,
+        sys = sys_total,
+        stress_total = stress_total
+    )
 }
 
 

man/ecxsys.Rd

@@ -66,7 +66,7 @@ A list (of class ecxsys) containing many different objects of which
   }
 }
 \description{
-The ECx-SyS model for modeling concentration-effect relationships whith
+The ECx-SyS model for modeling concentration-effect relationships with
 hormesis.
 }
 \details{

man/predict_mixture.Rd

@@ -30,7 +30,7 @@ this should be 100 (the default).}
 }
 \value{
 A data frame with columns of the supplied concentrations and the
-  corresponding mixture effects.
+  corresponding mixture effects and stresses.
 }
 \description{
 Given the ecxsys models of two toxicants this method predicts the effects of