R/rms.classes.R

In christianparobek/skeleSim: Genetic Simulation Engine

setClassUnion("matrOrNULL", c("matrix", "NULL"))

#' @title rmetasim Parameters Class
#' @description An S4 class storing parameters specific to rmetasim
#'
#' @rdname rmetasim.classes
#'
#' @slot num.stg a single integer for number of stages
#' @slot self.rate a single numeric for selfing rate
#' @slot surv.matr a matrix of numerics for survival transitions between stages
#' @slot repr.matr a matrix of integers for reproductive (females)
#' @slot male.matr a matrix of integers for male contribution (males)
#' @slot carrying a single integer for carrying capacity
#' @slot init.pop.sizes a vector of integers for initial starting population census sizes (length number of pop'ns)
#' @slot num.alleles a vector of integers for number of alleles per locus (length number of loci)
#' @slot allele.freq a vector of numerics for initial allele frequencies ???
#' @slot num.gen a single integer of number of generations to run
#'
setClass(
  Class = "rmetasim.params",
  slots = c(
    num.stgs = "intOrNum", selfing = "intOrNum", surv.matr = "matrOrNULL",
    repr.matr = "matrOrNULL", male.matr = "matrOrNULL", carrying = "intOrNum",
    init.pop.sizes = "intOrNum", num.alleles = "intOrNum",
    allele.freqs = "listOrNULL", num.gen = "intOrNum"
  ),
  prototype = list(
    num.stgs = NULL, selfing = NULL, surv.matr = NULL, repr.matr = NULL,
    male.matr = NULL, carrying = NULL, init.pop.sizes = NULL,
    num.alleles = NULL, allele.freqs = NULL, num.gen = NULL
  )
)