V3.1.0

description

• Improved the documentation of the which argument in plot_survival() and plot_stress().
• Changed the default value of the which argument in the plot functions. Now it contains the proper default curve names. If it is NA only the axes and labels will get drawn.

system details

• R Version:4.0.3
• RStudio Version: 1.3.1093
• OS Version: Windows 10

checklist

• This merge introduces new features.
  • new features are documented
  • new features have tests
• update documentation including examples (if necessary)
• update and polish NEWS.md
• update version in DESCRIPTION
• update date in DESCRIPTION
• no remaining TODO, FIXME, or debug prints anywhere in the source files
• devtools::document() and commit the updated .Rd files
• devtools::check() without errors or warnings

R/plot_ecxsys.R

@@ -26,14 +26,15 @@
 #'
 #' @name plot_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
-#'   the observed survival and \code{"sys_tox_observed"} and
-#'   \code{"sys_tox_env_observed"} for the observed Sys. The default \code{NA}
-#'   only plots the most important curves. Use \code{which = "all"} to display
-#'   all curves. An empty vector or \code{NULL} creates just the axes.
+#' @param model The model object returned from \code{\link{ecxsys}}.
+#' @param which A vector of curve names to plot. Allowed are all values of
+#'   \code{names(model$curves)} except \code{"concentration"}. See the
+#'   \emph{Value} section of \code{\link{predict_ecxsys}} for descriptions of
+#'   these names. Additionally, you can use \code{"survival_tox_observed"} and
+#'   \code{"survival_tox_env_observed"} for the observed survival and
+#'   \code{"sys_tox_observed"} and \code{"sys_tox_env_observed"} for the
+#'   observed Sys. Use \code{NA} to only draw the axis and labels. Invalid names
+#'   will be silently ignored.
 #'
 #' @param show_legend Should the plot include a legend? Defaults to \code{FALSE}
 #'   because it may cover some parts of the plot depending on the plot size and