R/decisionarea.R

In ahart1-r-packages/flukeclimatemse: Run Climate Fluke MSE

# This script contains the management procedure function: decisionarea

#' @title Specify how quota is allocated to different area(s) by state or groups of states
#'
#' @description
#' This function takes the specified setting for management decision areas and returns the matrix indexing required to perform subsequent calculations for these decision areas.
#'
#' @param decisionArea A string specifying the management decision areas for the simulation, no default.
#'    "Coastline" = All nine states in which summer flounder are caught combined to form a single decision area.
#'    "FiveArea" = Connecticut, New York and New Jersey form a combined decision area; Delaware, Maryland and Virginia form a combined decision area; Massachusetts, Rhode Island and North Carolina each treated as independent decision areas.
#'    "SixArea" = Connecticut and New York form a combined decision area; Delaware, Maryland, and Virginia form a combined decsion area; Massachusetts, Rhode Island, New Jersey and North Carolina each treated as independent decision areas.
#'    "IndividualStates" =  All nine states in which summer flounder are caught are treated as independent decision areas
#' @param NStates A number indicating the number of states, default = 9.
#'
#' @return An areaindex which specifies column indexing for different management decision areas. This indexing assumes that columns are in the following order by state: MA, RI, CT, NY, NJ, DE, MD, VA, NC

#' @family Management procedure functions
#'
#' @examples
#'    # Specify a single decision area for the full coastline
#'    decisionarea(decisionArea = "Coastline", NStates = 9)
#'    # Specify 5 decision areas
#'    decisionarea(decisionArea = "FiveArea", NStates = 9)
#'    # Specify 6 decision areas
#'    decisionarea(decisionArea = "SixArea", NStates = 9)
#'    # Specify independent decision area for individual states
#'    decisionarea(decisionArea = "IndividualStates", NStates = 9)


decisionarea <- function(decisionArea = NULL,
                         NStates = 9){
  if(decisionArea == "Coastline"){
    areaindex <- list(c(seq(1:NStates)))
  } else if(decisionArea == "FiveArea"){ # MA, RI, CT/NY/NJ, DE/MD/VA, NC
    areaindex <- list(1, 2, c(3,4,5), c(6,7,8), 9)
  } else if(decisionArea == "SixArea"){ # MA, RI, CT/NY, NJ, DE/MD/VA, NC
    areaindex <- list(1, 2, c(3,4), 5, c(6,7,8), 9)
  } else if(decisionArea == "IndividualStates"){
    areaindex <- as.list(seq(1:NStates))
  }

  return(areaindex)
}