R/func_GetPSCFisheries.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
#=======================================================

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


#source(utils.R)




#' @title GetPSCFisheries
#'
#' @description  Retrieves the PSC fishery information from the database. Information include 
#' number of PSC fisheries, the PSC fisheries ID,  fisheries names and gears. 
#' 
#' 
#'
#' @param M A list passed to StartCohortAnalysis_Click
#'
#' @details
#'
#' @return D: A list containing the folowing objects NumberPSCFisheries (double),
#' PSCFisheryNumber (vector), PSCFisheryName (vector), PSCFisheryGear (vector).
#' 
#' 
#' @export
#'
#' @examples
#' 
#' 
GetPSCFisheries <- function(M){

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


    #dta <- RODBC::odbcConnectAccess2007(M$datbse)   #specifies the file path

    #'Get name,number,gear of PSCFisheries
    
    ERASQL2 = "SELECT ID, Name, Gear from ERA_PSCFishery"
    df1 <-  RODBC::sqlQuery( M$chnl , query = ERASQL2)
    names(df1) <- c("PSCFisheryNumber","PSCFisheryName","PSCFisheryGear")
            
    NumberPSCFisheries <- nrow(df1)    
    

    #d<-list(NumberPSCFisheries=NumberPSCFisheries,
    #  PSCFisheriesdf=df1)


    d <- list(NumberPSCFisheries=NumberPSCFisheries,
              PSCFisheryNumber = df1$PSCFisheryNumber,
              PSCFisheryName = df1$PSCFisheryName,
              PSCFisheryGear = df1$PSCFisheryGear)
	
    return(d)

}