R/func_GetERAFisheries.R

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

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

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





#' @title GetERAFisheries
#'
#' @description  Only used if the model is set to replicate Coshak (CAS).  Retrieves the ERA fishery information from the 
#' database.
#' 
#' 
#'
#' @param M A list passed to StartCohortAnalysis_Click and appended to the output of GetPSCFisheries
#'
#' @details
#'
#' @return A list including the following objects: NumberERAFisheries, ERAFisheryNumber, and ERAFisheryName 
#' 
#' 
#' @export
#'
#' @examples
#' 
#' 
GetERAFisheries <- function(M){

    #========================================================
    #TODO: Add compatibility with DGM data output
    #========================================================



	#    'Get number of ERAFisheries
    #dta <- RODBC::odbcConnectAccess2007(M$datbse)   #specifies the file path
  
    #    'Get name,number,gear of ERAFisheries 
    ERASQL2 <- "SELECT ID,Name from ERA_ERAFishery"
    df1 <-  RODBC::sqlQuery( M$chnl , query = ERASQL2)

    NumberERAFisheries <- nrow(df1)
	names(df1) <- c("ERAFisheryNumber","ERAFisheryName")

   	D <- list( NumberERAFisheries= NumberERAFisheries,
   	ERAFisheryNumber = df1$ERAFisheryNumber,
   	ERAFisheryName = df1$ERAFisheryName)
	
	return(D)


	#Original ERA code
	#NumberERAFisheries = 0
    #    'Get number of ERAFisheries
    #    ERASQL = "SELECT MAX(ID) from ERA_ERAFishery"
    #    ERACommand = New OleDbCommand(ERASQL, CISDBConnection)
    #    CISDataReader = ERACommand.ExecuteReader()
    #    CISDataReader.Read()
    #    NumberERAFisheries = CISDataReader(0)
    #    CISDataReader.Close()
    #    'Get name,number,gear of ERAFisheries
    #    ReDim ERAFisheryName(NumberERAFisheries)
    #    ERASQL = "SELECT ID,Name from ERA_ERAFishery"
    #    ERACommand = New OleDbCommand(ERASQL, CISDBConnection)
    #    CISDataReader = ERACommand.ExecuteReader()
    #    Do While CISDataReader.Read()
    #        Dim ERAFisheryNumber As Integer
    #        ERAFisheryNumber = CISDataReader(0)
    #        ERAFisheryName(ERAFisheryNumber) = CISDataReader(1)
    #    Loop
    #    CISDataReader.Close()

}