R/makeAvailable.R

Defines functions makeAvailable

#' Convenience function to make the initial available animal list
#'
## Copyright(c) 2017-2024 R. Mark Sharp
## This file is part of nprcgenekeepr
#'
#' @return Initial available animals list
#'
#' @param candidates character vector of IDs of the animals available for
#' use in the group.
#' @param numGp integer value indicating the number of groups that should be
#' formed from the list of IDs. Default is 1.
#' @noRd
makeAvailable <- function(candidates, numGp) {
  available <- list()
  for (i in 1L:numGp) {
    available[[i]] <- candidates
  }
  available
}
rmsharp/nprcgenekeepr documentation built on June 13, 2025, 9:16 p.m.