R/NFLD_DATRAS.R

In Maritimes/CanaDatras: Facilitates converting Canadian Trawl Survey Data into DATRAS format

#' @title NFLD_DATRAS
#' @description This is a placeholder for an imaginary function which would generate
#' ICES DATRAS-compatible files for NFLD region.
#' @param yr default is \code{NULL}. This specifies the year(s) for which you'd like to generate
#' HH files. Single years are fine, as are vectors (e.g. \code{c(2011,1015)}, \code{2015:2019})
#' @param survey default is \code{NULL}.
#' @param csv default is \code{TRUE}.  If \code{TRUE}, csv files are generated for each HH code.  If
#' \code{FALSE}, the output exists only in the resultant list.
#' @param debug  The default is \code{F}. Setting this to TRUE will limit the 
#' results to a single set for a single species. 
#' @return a list containing (named) objects - 1 for each generated HH file
#' @family DATRAS
#' @author Mike McMahon, \email{Mike.McMahon@@dfo-mpo.gc.ca}
#' @export
#'
NFLD_DATRAS <- function(yr=NULL, survey=NULL, csv = NULL, debug=FALSE){
  cat("\n","NFLD not implemented yet")
  return(NULL)
}