R/ancestry.R

In fransilvion/REvolution: Game of Evolution

#' ancestry - class definition
#'
#' For each geneartion (G_i) in the Game of Evolution
#' The ancestry of organisms is stored as a matrix
#'
#' This is the class definition a matrix contianing this information for
#' generations 1 through n
#'
#' @param map a martix of numbers corresponding to which organisms of the previous generation each generation is related to
#'
#' @return population
#'
#' @examples
#'
#' #Each row of the map in the ancestry object must be sorted in ascending order
#' 
#' ancestry_map <- ancestry( map = rbind(c(1,2,3,4,5),c(2,4,4,5,5)) )
#'
#' @export
ancestry <- setClass(Class = "ancestry", representation(map = "matrix"))