Add return values to some documentation

According to CRAN rules all exported functions must specify a return value.

DESCRIPTION

 Package: stressaddition
 Type: Package
 Title: Modelling Tri-Phasic Concentration-Response Relationships
-Version: 3.0.0
-Date: 2020-07-06
+Version: 3.0.1
+Date: 2020-07-28
 Authors@R: c(person("Sebastian", 
                     "Henz", 
                     role = c("aut", "cre"), 

R/plot_ecxsys.R

@@ -40,6 +40,8 @@
 #'   the number of elements shown.
 #' @param xlab,ylab,main Axis labels and title.
 #'
+#' @return None
+#'
 #' @examples model <- ecxsys(
 #'     concentration = c(0, 0.05, 0.5, 5, 30),
 #'     hormesis_concentration = 0.5,

R/plot_stress.R

@@ -194,4 +194,5 @@ plot_stress <- function(model,
             )
         }
     }
+    NULL  # suppress all possible return values
 }

R/plot_survival.R

@@ -175,4 +175,5 @@ plot_survival <- function(model,
             )
         }
     }
+    NULL  # suppress all possible return values
 }

R/stress_survival_conversion.R

@@ -24,9 +24,7 @@
 #'
 #' These are simple wrappers around the beta distribution function
 #' \code{\link[stats:Beta]{pbeta}} and the beta quantile function
-#' \code{\link[stats:Beta]{qbeta}}. \code{stress_to_survival} returns \code{1 -
-#' pbeta(stress, p, q)}. \code{survival_to_stress} first clamps the survival to
-#' the interval [0, 1] and then returns \code{qbeta(1 - survival, p, q)}.
+#' \code{\link[stats:Beta]{qbeta}}.
 #'
 #' @name Stressconversion
 #'
@@ -37,6 +35,12 @@
 #' @param p,q The shape parameters of the \code{\link[stats:Beta]{beta}}
 #'   distribution. Default is 3.2.
 #'
+#' @return \code{stress_to_survival} returns a vector the same length as
+#'   \code{stress} giving the survival caused by each amount of stress.
+#'
+#'   \code{survival_to_stress} returns a vector the same length as
+#'   \code{survival} containing the stress values associated with each survival.
+#'
 #' @examples
 #' stress <- 0.3
 #' survival <- stress_to_survival(stress)

man/Stressconversion.Rd

@@ -20,6 +20,13 @@ distribution. Default is 3.2.}
 
 \item{stress}{One or more stress values to convert to survival.}
 }
+\value{
+\code{stress_to_survival} returns a vector the same length as
+  \code{stress} giving the survival caused by each amount of stress.
+
+  \code{survival_to_stress} returns a vector the same length as
+  \code{survival} containing the stress values associated with each survival.
+}
 \description{
 Functions to convert survival to general stress or vice versa using the beta
 distribution.
@@ -27,9 +34,7 @@ distribution.
 \details{
 These are simple wrappers around the beta distribution function
 \code{\link[stats:Beta]{pbeta}} and the beta quantile function
-\code{\link[stats:Beta]{qbeta}}. \code{stress_to_survival} returns \code{1 -
-pbeta(stress, p, q)}. \code{survival_to_stress} first clamps the survival to
-the interval [0, 1] and then returns \code{qbeta(1 - survival, p, q)}.
+\code{\link[stats:Beta]{qbeta}}.
 }
 \examples{
 stress <- 0.3

man/plot_ecxsys.Rd

@@ -42,6 +42,9 @@ the number of elements shown.}
 
 \item{xlab, ylab, main}{Axis labels and title.}
 }
+\value{
+None
+}
 \description{
 Plot the observed and modeled survivals and stresses.
 }