R/setInitialValues.R

Defines functions initialNResource.MizerSim initialNResource.MizerParams initialNResource `initialNResource<-.MizerParams` `initialNResource<-` initialN.MizerSim initialN.MizerParams initialN `initialN<-.MizerParams` `initialN<-` setInitialValues.MizerParams setInitialValues

Documented in initialN initialN.MizerParams initialN.MizerSim initialNResource initialNResource.MizerParams initialNResource.MizerSim setInitialValues

#' Set initial values to values from a simulation
#'
#' `r lifecycle::badge("deprecated")`
#'
#' @description
#' `r lifecycle::badge("deprecated")`
#' This function is deprecated. Use [getParams()], [initialParams()], or
#' [finalParams()] instead. These functions return a `MizerParams` object
#' with the ecosystem state extracted from a simulation.
#'
#' @param params A `MizerParams` object in which to set the initial values
#' @param sim A `MizerSim` object from which to take the values.
#' @param time_range The time range to average the abundances over. Can be a
#'   vector of values, a vector of min and max time, or a single value. Only the
#'   range of times is relevant, i.e., all times between the smallest and
#'   largest will be selected.  Default is the final time step.
#' @param geometric_mean `r lifecycle::badge("experimental")`
#'   If TRUE then the average of the abundances over the
#'   time range is a geometric mean instead of the default arithmetic mean. This
#'   does not affect the average of the effort or of other components, which is
#'   always arithmetic.
#' @param ... Additional arguments passed to the method.
#'
#' @return The `params` object with updated initial values and initial effort.
#' @export
#' @concept deprecated
#' @examples
#' \donttest{
#' params <- NS_params
#' sim <- project(params, t_max = 20, effort = 0.5)
#' params <- setInitialValues(params, sim)
#' }
setInitialValues <- function(params, sim, time_range, geometric_mean = FALSE, ...) {
    UseMethod("setInitialValues")
}
#' @export
setInitialValues.MizerParams <- function(params, sim, time_range, geometric_mean = FALSE, ...) {
    lifecycle::deprecate_warn(
        "3.0.0", "setInitialValues()",
        details = paste0("Use `getParams(sim, time_range, geometric_mean)` to ",
                         "extract a MizerParams object with updated initial ",
                         "values. Convenience wrappers `initialParams()` and ",
                         "`finalParams()` extract the first and last time steps.")
    )
    assert_that(is(sim, "MizerSim"),
                is.flag(geometric_mean))
    no_t <- dim(sim@n)[1]
    if (!identical(dim(sim@n)[2:3], dim(params@initial_n))) {
        stop("The consumer size spectrum of the simulation in `sim` has a ",
             "different size from that in `params`.")
    }
    if (!identical(params@species_params$species,
                   sim@params@species_params$species)) {
        stop("The species in `sim` have different names from those in `params`.")
    }
    if (!identical(length(sim@n_pp[no_t, ]), length(params@initial_n_pp))) {
        stop("The resource size spectrum of the simulation in `sim` has a ",
             "different size from that in `params`.")
    }
    if (!identical(length(sim@n_other[no_t, ]), length(params@initial_n_other))) {
        stop("The number of other components in the simulation in `sim` is ",
             "different from that in `params`.")
    }
    if (!identical(length(sim@effort[no_t, ]), length(params@initial_effort))) {
        stop("The number of gears in the simulation in `sim` is ",
             "different from that in `params`.")
    }
    if (!identical(dimnames(sim@effort)[[2]], names(params@initial_effort))) {
        stop("The gears in the simulation in `sim` have different names ",
             "from those in `params`.")
    }
    if (missing(time_range)) {
        time_range  <- max(as.numeric(dimnames(sim@n)$time))
    }
    time_elements <- get_time_elements(sim, time_range)
    mean_fn <- mean
    if (geometric_mean) {
        mean_fn <- function(x) {
            exp(mean(log(x)))
        }
    }
    params@initial_n[] <-
        apply(sim@n[time_elements, , , drop = FALSE], c(2, 3), mean_fn)
    params@initial_n_pp[] <-
        apply(sim@n_pp[time_elements, , drop = FALSE], 2, mean_fn)
    # Below we have to work around the fact that "+" does not do
    # componentwise addition of lists
    mizer_add <- function(l1, l2) {
        ifelse(is.list(l1), Map("+", l1, l2), l1 + l2)
    }
    params@initial_n_other[] <-
        apply(sim@n_other[time_elements, , drop = FALSE], 2,
              function(l) Reduce(mizer_add, l) / length(l),
              simplify = FALSE)

    params@initial_effort[] <-
        apply(sim@effort[time_elements, , drop = FALSE], 2, mean)

    params@time_modified <- lubridate::now()
    params
}

#' Initial values for fish spectra
#'
#' Values used as starting values for simulations with `project()`.
#'
#' @param params A MizerParams object
#' @param value A matrix with dimensions species x size holding the initial
#'   number densities for the fish spectra.
#' @export
`initialN<-` <- function(params, value) {
    UseMethod("initialN<-")
}
#' @export
`initialN<-.MizerParams` <- function(params, value) {
    assert_that(identical(dim(value), dim(params@initial_n)),
                all(value >= 0))
    if (!is.null(dimnames(value)) &&
        !identical(dimnames(value), dimnames(params@initial_n))) {
        warning("The dimnames do not match. I will ignore them.")
    }
    params@initial_n[] <- value

    params@time_modified <- lubridate::now()
    params
}

#' @rdname initialN-set
#' @param object An object of class MizerParams or MizerSim
#' @return An `ArraySpeciesBySize` object with dimensions species x size holding
#'   the initial number densities for the fish spectra.
#' @export
#' @seealso [initialNResource()], [initialNOther()]
#' @examples
#' # Doubling abundance of Cod in the initial state of the North Sea model
#' params <- NS_params
#' initialN(params)["Cod", ] <- 2 * initialN(params)["Cod", ]
initialN <- function(object) {
    UseMethod("initialN")
}
#' @rdname initialN-set
#' @usage NULL
#' @export
initialN.MizerParams <- function(object) {
    params <- validParams(object)
    ArraySpeciesBySize(params@initial_n, value_name = "Number density",
                       type = "density", params = params)
}
#' @rdname initialN-set
#' @usage NULL
#' @export
initialN.MizerSim <- function(object) {
    ArraySpeciesBySize(object@params@initial_n,
                       value_name = "Number density",
                       type = "density", params = object@params)
}

#' Initial value for resource spectrum
#'
#' Value used as starting value for simulations with `project()`.
#'
#' @param params A MizerParams object
#' @param value A vector with the initial number densities for the resource
#'   spectrum
#' @export
#' @seealso [initialN()], [initialNOther()]
#' @examples
#' # Doubling resource abundance in the initial state of the North Sea model
#' params <- NS_params
#' initialNResource(params) <- 2 * initialNResource(params)
`initialNResource<-` <- function(params, value) {
    UseMethod("initialNResource<-")
}
#' @export
`initialNResource<-.MizerParams` <- function(params, value) {
    assert_that(identical(dim(value), dim(params@initial_n_pp)),
                all(value >= 0))
    if (!is.null(dimnames(value)) &&
        !identical(dimnames(value), dimnames(params@initial_n_pp))) {
        warning("The dimnames do not match. I will ignore them.")
    }
    params@initial_n_pp[] <- value

    params@time_modified <- lubridate::now()
    params
}

#' @rdname initialNResource-set
#' @param object An object of class MizerParams or MizerSim
#' @return A vector with the initial number densities for the resource
#'   spectrum
#' @export
initialNResource <- function(object) {
    UseMethod("initialNResource")
}
#' @rdname initialNResource-set
#' @usage NULL
#' @export
initialNResource.MizerParams <- function(object) {
    params <- validParams(object)
    ArrayResourceBySize(params@initial_n_pp, value_name = "Number density",
                        units = "1/g", type = "density", params = params)
}
#' @rdname initialNResource-set
#' @usage NULL
#' @export
initialNResource.MizerSim <- function(object) {
    ArrayResourceBySize(object@params@initial_n_pp,
                        value_name = "Number density", units = "1/g",
                        type = "density", params = object@params)
}

Try the mizer package in your browser

Any scripts or data that you put into this service are public.

mizer documentation built on Aug. 31, 2026, 5:08 p.m.