Multipop calcPopValue and updates

DESCRIPTION

@@ -43,7 +43,7 @@ Depends: R (>= 4.0.0)
 Imports: Rcpp (>= 0.12.7), Rdpack, methods, R6
 RdMacros: Rdpack
 LinkingTo: Rcpp, RcppArmadillo (>= 0.7.500.0.0), BH, dqrng (>= 0.4.1)
-RoxygenNote: 7.3.3
 Suggests: knitr, rmarkdown, testthat
 VignetteBuilder: knitr
 NeedsCompilation: true
+Config/roxygen2/version: 8.0.0

NAMESPACE

@@ -19,6 +19,7 @@ export(attrition)
 export(bv)
 export(cChr)
 export(calcGCA)
+export(calcPopValue)
 export(dd)
 export(doubleGenome)
 export(ebv)
@@ -112,6 +113,7 @@ export(solveRRBLUP_EM)
 export(solveRRBLUP_EM2)
 export(solveRRBLUP_EM3)
 export(solveUVM)
+export(splitPop)
 export(unnameMultiPop)
 export(usefulness)
 export(varA)

NEWS.md

@@ -12,12 +12,16 @@
 
 * Added `flattenMultiPop()` function to reduce the depth of a nested MultiPop object up to a defined `level`.
 
-* Added `selectPop()` function to select a subset of populations from a MultiPop. This function uses the new internal `calcPopValue()` function to calculate a summary value for each population, which is then used for selection.
+* Added `calcPopValue()` function to calculate summary values for each Pop in a MultiPop.
+
+* Added `selectPop()` function to select a subset of populations from a MultiPop. This function uses the new `calcPopValue()` function.
 
 * Added `unnameMultiPop()` function to remove names from a MultiPop at specific `level`(s).
 
 * Added `newEmptyMultiPop()` function to create an empty MultiPop. It has the same outcome as `newMultiPop()` with no arguments. To make this behavior consistent with `newEmptyPop()`, `newPop()` now also supports creating an empty population with defined ploidy.
 
+* Added `splitPop()` function to divide a Pop or MultiPop object into multiple subpopulations at specified level(s).
+
 * Update `mergePops()` to handle nested MultiPop objects.
 
 * Added asLogNormal() function.

R/Class-Pop.R

@@ -1044,6 +1044,7 @@ setValidity("MultiPop",function(object){
   errors = character()
     # Check that all populations are valid
     for(i in seq_len(length(object@pops))){
+      # TODO: Validate names before returning multiPops
       if(!validObject(object@pops[[i]]) &
          (is(object@pops[[i]], "Pop") |
                 is(object@pops[[i]],"MultiPop"))){
@@ -1433,6 +1434,7 @@ newEmptyMultiPop = function(){
 #'
 #' # Set simulation parameters
 #' SP = SimParam$new(founderPop)
+#' \dontshow{SP$nThreads = 1L}
 #'
 #' # Create population
 #' pop = newPop(founderPop, simParam = SP)
@@ -1458,6 +1460,8 @@ newEmptyMultiPop = function(){
 #'
 #' @export
 unnameMultiPop = function(x, level = Inf) {
+  stopifnot(isMultiPop(x))
+
   # Get max depth of nesting in MultiPop
   md = .depthMultiPop(x)