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 @@

Arguments

Value

-

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.

diff --git a/docs/reference/plot-MizerParams-missing-method.html b/docs/reference/plot-MizerParams-missing-method.html index a558f6a9..7d4149f2 100644 --- a/docs/reference/plot-MizerParams-missing-method.html +++ b/docs/reference/plot-MizerParams-missing-method.html @@ -77,6 +77,23 @@

Usage plot(x, y, ...)

+
+

Arguments

+ + +
x
+

An object of class MizerParams

+ + +
y
+

Not used

+ + +
...
+

For additional arguments see the documentation for +plotFeedingLevel(),plotSpectra(),plotPredMort()

+ +

Value

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 @@

Arguments

Value

-

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.

diff --git a/man/completeSpeciesParams.Rd b/man/completeSpeciesParams.Rd index 3c0f4668..aad4d839 100644 --- a/man/completeSpeciesParams.Rd +++ b/man/completeSpeciesParams.Rd @@ -10,10 +10,10 @@ completeSpeciesParams(species_params) \item{species_params}{The user-supplied species parameter data frame} } \value{ -For validSpeciesParams(): A valid species parameter data frame with +For \code{validSpeciesParams()}: A valid species parameter data frame with additional parameters with default values. -For validGivenSpeciesParams(): A valid species parameter data frame +For \code{validGivenSpeciesParams()}: A valid species parameter data frame without additional parameters. } \description{ diff --git a/man/plot-MizerParams-missing-method.Rd b/man/plot-MizerParams-missing-method.Rd index 1819d3af..15dc42da 100644 --- a/man/plot-MizerParams-missing-method.Rd +++ b/man/plot-MizerParams-missing-method.Rd @@ -6,6 +6,14 @@ \usage{ \S4method{plot}{MizerParams,missing}(x, y, ...) } +\arguments{ +\item{x}{An object of class \linkS4class{MizerParams}} + +\item{y}{Not used} + +\item{...}{For additional arguments see the documentation for +\code{\link[=plotFeedingLevel]{plotFeedingLevel()}},\code{\link[=plotSpectra]{plotSpectra()}},\code{\link[=plotPredMort]{plotPredMort()}}} +} \value{ A viewport object } diff --git a/man/validSpeciesParams.Rd b/man/validSpeciesParams.Rd index d750ab91..a4f2b260 100644 --- a/man/validSpeciesParams.Rd +++ b/man/validSpeciesParams.Rd @@ -13,10 +13,10 @@ validGivenSpeciesParams(species_params) \item{species_params}{The user-supplied species parameter data frame} } \value{ -For validSpeciesParams(): A valid species parameter data frame with +For \code{validSpeciesParams()}: A valid species parameter data frame with additional parameters with default values. -For validGivenSpeciesParams(): A valid species parameter data frame +For \code{validGivenSpeciesParams()}: A valid species parameter data frame without additional parameters. } \description{