setClassUnion("matrOrNULL", c("matrix", "NULL"))
setClassUnion("logOrNULL", c("logical", "NULL"))
setClassUnion("intOrNULL", c("integer", "NULL"))
#' @title fastsimcoal Parameters Class
#' @description An S4 class storing parameters specific to fastsimcoal
#'
#' @slot fastsimcoal.exec character string for the fastsimcoal command line
#' executable.
#' @slot pop.info matrix of population sampling information created by the
#' \code{\link{fscPopInfo}} function.
#' @slot hist.ev matrix of historical events created by the
#' \code{\link{fscHistEv}} function.
#' @slot locus.params data.frame specifying loci to simulate created by the
#' \code{\link{fscLocusParams}} function.
#' @slot growth.rate a vector \code{num.pop} long giving the growth rate of
#' each population.
#' @slot sample.times a vector \code{num.pop} long giving the time (in generations)
#' that samples are drawn from in population.
#'
#' @export
#'
fastsimcoal.params <- setClass(
Class = "fastsimcoal.params",
slots = c(
fastsimcoal.exec = "character", pop.info = "matrOrNULL",
hist.ev = "matrOrNULL", locus.params = "dfOrNULL",
growth.rate = "intOrNum", sample.times = "intOrNum"
),
prototype = list(
fastsimcoal.exec = "fsc252", pop.info = NULL,
hist.ev = NULL, locus.params = NULL,
growth.rate = NULL, sample.times = NULL
),
validity = function(object) {
return(TRUE)
}
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.