R/func_GetWithinBYWeightFlagAndPNVRegionAndAvgMatRates.R

In catarinawor/ERAR: This package is a loose translation of the Chinook Technical committee ERA model

#=======================================================
#ERA function GetFirstAndLastBY()
#Translated from VB ERA CIS code
#October 2018
#Author: Catarina Wor
#=======================================================

#=======================================================


#source(utils.R)




#' @title GetWithinBYWeightFlagAndPNVRegionAndAvgMatRate
#'
#' @description  Retrives PNVRegion, AverageMatRate, PNVRegion, WithinBYWeightFlag from ERA_Stock table
#' 
#' 
#'
#' @param M A list passed to MainSub
#' 
#' @param D A list containin ERA stock specific information
#'
#'
#' @return D: A list containing information regarding OceanAge, AverageMatRate, PNVRegion, WithinBYWeightFlag
#' 
#' 
#' @export
#'
#' @examples
#' 
#' 
GetWithinBYWeightFlagAndPNVRegionAndAvgMatRates <- function(D,M){

    #dta <- RODBC::odbcConnectAccess2007(M$datbse)      


    #  'determines whether Within BY Weighting occurs for a stock
    ERASQL = paste0("Select PNVRegion, WithinBYWeightFlag, AverageMatRateFlag, Age2AverageMatRate, Age3AverageMatRate, Age4AverageMatRate, Age5AverageMatRate from ERA_Stock Where ERAStock = '", D$CurrentStock , "'")

    df1 <- RODBC::sqlQuery( M$chnl , query = ERASQL )
        
    
    if(df1$AverageMatRateFlag){ 
        if(is.na(sum(df1[,-c(1:3)]))){
            nome<- "../logs/GetWithinBYWeightFlagAndPNVRegionAndAvgMatRate.log"
            sink(nome)
            cat(paste("You have selected the AverageMatRateFlag in the ERA_Stock table, but not all average maturation rates have been entered in the table. The program will stop. Error"))
            sink()
            return(list(longerr=1))
        }else{
            return(list( OceanAge=D$OceanStartAge:(D$OceanStartAge+3),
            AverageMatRate=df1[,-c(1:3)],
            PNVRegion=df1$PNVRegion,
            WithinBYWeightFlag= df1$WithinBYWeightFlag,
            ReadAvgMatRteFlg=df1$AverageMatRateFlag,
            longerr=0))
        }
    
    }else{
        return(list( OceanAge=D$OceanStartAge:(D$OceanStartAge+3),
            PNVRegion=df1$PNVRegion,
            WithinBYWeightFlag= df1$WithinBYWeightFlag,
            ReadAvgMatRteFlg=df1$AverageMatRateFlag,
            longerr=0))
    }
       



        #original VB code
        #=================================================================================
        #'determines whether Within BY Weighting occurs for a stock
        #ERASQL = "Select PNVRegion, WithinBYWeightFlag, AverageMatRateFlag, Age2AverageMatRate, Age3AverageMatRate, Age4AverageMatRate, Age5AverageMatRate from ERA_Stock Where ERAStock = '" & CurrentStock & "'"
        #ERACommand = New OleDbCommand(ERASQL, CISDBConnection)
        #CISDataReader = ERACommand.ExecuteReader()
        #CISDataReader.Read()
        #PNVRegion = CISDataReader(0)
        #withinBYWeightFlag = CISDataReader(1)
        #ReadAvgMatRteFlg = CISDataReader(2)
        #If ReadAvgMatRteFlg = True Then
        #    Try
        #        AverageMatRate(OceanStartAge) = CISDataReader(3)
        #        AverageMatRate(OceanStartAge + 1) = CISDataReader(4)
        #        AverageMatRate(OceanStartAge + 2) = CISDataReader(5)
        #        AverageMatRate(OceanStartAge + 3) = CISDataReader(6)
        #    Catch
        #        MsgBox("You have selected the AverageMatRateFlag in the ERA_Stock table, but not all average maturation rates have been entered in the table. " & vbCr & "The program will stop.", , "Error")
        #        End
        #    End Try
        #End If
        #CISDataReader.Close()
        
        
}