R/NResource.R

In sizespectrum/mizerMR: Add multiple size-structured resources to a mizer model

#' Access resource abundances in simulation result
#'
#' @param sim A MizerSim object
#' @return For `NResource()`: An array (time x resource x size) holding the
#'   resource number densities at all saved timesteps of the simulation.
#' @export
NResource <- function(sim) {
    if (is.null(getComponent(getParams(sim), "MR"))) {
        return(mizer::NResource(sim))
    }
    n_res <- aperm(simplify2array(NOther(sim)[, "MR"]), c(3, 1, 2))
    dimnames(n_res)[[1]] <- dimnames(NOther(sim))[[1]]
    names(dimnames(n_res))[[1]] <- names(dimnames(NOther(sim)))[[1]]
    n_res
}

#' @rdname NResource
#' @return For `finalNResource()`: An array (resource x size) holding the
#'   resource number densities at the end of the simulation
#' @export
finalNResource <- function(sim) {
    if (is.null(getComponent(getParams(sim), "MR"))) {
        return(mizer::finalNResource(sim))
    }
    NOther(sim)[[idxFinalT(sim), "MR"]]
}