R/get.cohorts.R

In MoBPS: Modular Breeding Program Simulator

'#
  Authors
Torsten Pook, torsten.pook@uni-goettingen.de

Copyright (C) 2017 -- 2020  Torsten Pook

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 3
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
'#

#' Export Cohort-names
#'
#' Function to export cohort names for the population list
#' @param population Population list
#' @param extended extended cohorts
#' @examples
#' data(ex_pop)
#' get.cohorts(ex_pop)
#' @return List of all cohorts in the population-list
#' @export

get.cohorts <- function(population, extended=FALSE){
  if(extended){
    return(population$info$cohorts)
  } else{
    return(as.character(population$info$cohorts[,1]))
  }

}