R/getLifeStageInfo.POP.R

In wStockhausen/wtsDisMELSConn: Functions for dealing with DisMELS IBM model output, including calculating and analyzing connectivity matrices

#'
#'@title Get a list that defines life stage info for the DisMELS POP IBM
#'
#'@description Function to get a list that defines life stage info for the DisMELS POP IBM.
#'
#'@return a list
#'
#'@details none.
#'
#'@export
#'
getLifeStageInfo.POP<-function(){
    #results file type
    resType<-'OLD';
    
    #java class names
    classNames<-c('SimplePelagicLHS',
                  'SimpleSettlerLHS',
                  'SimpleBenthicJuvenileLHS');
    
    #names of 'additional attributes' variables for each life stage class
    PelagicClassInfo <-NULL;
    SettlerClassInfo <-NULL;
    JuvenileClassInfo<-NULL;
    
    #data types
    PelagicClassDataTypes  <- NULL;
    SettlerClassDataTypes  <- NULL;
    JuvenileClassDataTypes <- NULL;
    
    #class info
    info.classes<-list(SimplePelagicLHS        =list(vars=PelagicClassInfo, types=PelagicClassDataTypes),
                       SimpleSettlerLHS        =list(vars=SettlerClassInfo, types=SettlerClassDataTypes),
                       SimpleBenthicJuvenileLHS=list(vars=JuvenileClassInfo,types=JuvenileClassDataTypes))
    
    
    #defined life stage type names (NOT class names)
    lifeStageTypes=list(preflexion.larva =list(class=classNames[1],info=info.classes[[1]]),
                        postflexion.larva=list(class=classNames[1],info=info.classes[[1]]),
                        pelagic.juvenile =list(class=classNames[1],info=info.classes[[1]]),
                        settler          =list(class=classNames[2],info=info.classes[[2]]),
                        benthic.juvenile =list(class=classNames[3],info=info.classes[[3]]));
    
    return(invisible(list(resType=resType,classNames=classNames,classInfo=info.classes,lifeStageTypes=lifeStageTypes)));
}