Expand colony value functions for MultiColony

[janaobsteter]

Functions such as nDronesColonyPhenotype etc. in Class-SimParamBee.R

[janaobsteter]

It seems some functions use colony argument for no reason? I'll remove these.

nWorkersPoisson <- function(colony, n = 1, average = 100) {
  return(rpois(n = n, lambda = average))
}

#' @describeIn nWorkersFun Sample a non-zero number of workers
#' @export
nWorkersTruncPoisson <- function(colony, n = 1, average = 100, lowerLimit = 0) {
  return(extraDistr::rtpois(n = n, lambda = average, a = lowerLimit))
}

[janaobsteter]

I also realised that nWorkersPoisson, nDronesPoisson, nVirginQueensPoisson etc. all do the same thing --> so am squishing them into nCastePoisson, nCasteTruncPoisson ... Might need to create aliases so that previous versions don't fail.

[gregorgorjanc]

Good call on nCastePoisson() etc.!

Yeah, I don't know why the n... functions have the colony argument ... aha, the answer lies in nWorkersColonyPhenotype()! It's definition is:

> nWorkersColonyPhenotype
function(colony, queenTrait = 1, workersTrait = NULL,
                                    checkProduction = FALSE, lowerLimit = 0,
                                    simParamBee = NULL,
                                    ...) {
  if (is.null(simParamBee)) {
    simParamBee <- get(x = "SP", envir = .GlobalEnv)
  }
  ret <- round(mapCasteToColonyPheno(
    colony = colony,
    queenTrait = queenTrait,
    workersTrait = workersTrait,
    checkProduction = checkProduction,
    simParamBee = simParamBee,
    ...
  ))
  if (ret < (lowerLimit + 1)) {
    ret <- lowerLimit + 1
  }
  return(ret)
}
<environment: namespace:SIMplyBee>

So this one needs access to colony for mapCasteToColonyPheno and then I believe we said that we will have all these value/n functions following the same convention - that sometimes they will produce value by themselves with no colony input (like nWorkersPoisson), but more involved functions need colony as input (like nWorkersColonyPhenotype). Does this makes sense? Do we need to update the Sampling functions vignette to make this clearer?