diff --git a/R/plots.R b/R/plots.R index cf579b18..b769946e 100644 --- a/R/plots.R +++ b/R/plots.R @@ -1403,6 +1403,10 @@ setMethod("plot", signature(x = "MizerSim", y = "missing"), #' level and predation mortality of each species through time. This method just #' uses the other plotting functions and puts them all in one window. #' +#' @param x An object of class \linkS4class{MizerParams} +#' @param y Not used +#' @param ... For additional arguments see the documentation for +#' [plotFeedingLevel()],[plotSpectra()],[plotPredMort()] #' @return A viewport object #' @export #' @family plotting functions diff --git a/R/validSpeciesParams.R b/R/validSpeciesParams.R index 393919d2..200438d0 100644 --- a/R/validSpeciesParams.R +++ b/R/validSpeciesParams.R @@ -55,7 +55,7 @@ #' list of these functions). #' #' @param species_params The user-supplied species parameter data frame -#' @return For validSpeciesParams(): A valid species parameter data frame with +#' @return For `validSpeciesParams()`: A valid species parameter data frame with #' additional parameters with default values. #' #' @seealso [species_params()], [validGearParams()], [validParams()], [validSim()] @@ -73,7 +73,7 @@ validSpeciesParams <- function(species_params) { } #' @rdname validSpeciesParams -#' @return For validGivenSpeciesParams(): A valid species parameter data frame +#' @return For `validGivenSpeciesParams()`: A valid species parameter data frame #' without additional parameters. #' @export validGivenSpeciesParams <- function(species_params) { diff --git a/docs/reference/completeSpeciesParams.html b/docs/reference/completeSpeciesParams.html index 7cc837a1..61d3c03c 100644 --- a/docs/reference/completeSpeciesParams.html +++ b/docs/reference/completeSpeciesParams.html @@ -83,9 +83,9 @@
For validSpeciesParams(): A valid species parameter data frame with +
For validSpeciesParams()
: A valid species parameter data frame with
additional parameters with default values.
For validGivenSpeciesParams(): A valid species parameter data frame +
For validGivenSpeciesParams()
: A valid species parameter data frame
without additional parameters.
An object of class MizerParams
Not used
For additional arguments see the documentation for
+plotFeedingLevel()
,plotSpectra()
,plotPredMort()
A viewport object
diff --git a/docs/reference/validSpeciesParams.html b/docs/reference/validSpeciesParams.html index d5db178a..0c8b07b9 100644 --- a/docs/reference/validSpeciesParams.html +++ b/docs/reference/validSpeciesParams.html @@ -97,9 +97,9 @@For validSpeciesParams(): A valid species parameter data frame with +
For validSpeciesParams()
: A valid species parameter data frame with
additional parameters with default values.
For validGivenSpeciesParams(): A valid species parameter data frame +
For validGivenSpeciesParams()
: A valid species parameter data frame
without additional parameters.