R/key.R

In TobieSurette/gulf.data: Southern Gulf of St Lawrence Data Access

#' \strong{gulf.data} Index Keys  
#' 
#' @description Define or extract index keys for various \code{gulf.data} objects.
#' 
#' @param x Data object.
#' 
#' @examples 
#' x <- read.scsset(2020)
#' key(x)
#' key.scsset()

#' @describeIn key Fetch \code{scsset} index key.
#' @export key.scsset
#' @export
key.scsset <- function(x, ...) if (missing(x)) return(c("date", "tow.id")) else return(gulf.metadata::key.default(x))

#' @describeIn key Index key for Northumberland Strait catch set (\code{nsscat}).
#' @export key.nssset
#' @export
key.nssset <- function(x, ...) if (missing(x)) return(c("date", "cruise", "set.number")) else return(gulf.metadata::key.default(x))

#' @describeIn key Index key for Northumberland Strait catch data (\code{nsscat}).
#' @export key.nsscat
#' @export
key.nsscat <- function(x, ...) if (missing(x)) return(c("date", "cruise", "set.number", "species")) else return(gulf.metadata::key.default(x))

#' @describeIn key Index key for Northumberland Strait biological data (\code{nssbio}).
#' @export key.nssbio
#' @export
key.nssbio <- function(x, ...) if (missing(x)) return(c("date", "cruise", "set.number", "species", "specimen")) else return(gulf.metadata::key.default(x))

#' @describeIn key Index key for Northumberland Strait length data (\code{nsslen}).
#' @export key.nsslen
#' @export
key.nsslen <- function(x, ...) if (missing(x)) return(c("date", "cruise", "set.number", "species", "size.class", "sex", "length")) else return(gulf.metadata::key.default(x))

#' @describeIn key Index key for snow crab survey by-catch data (\code{scscat}).
#' @export key.scscat
#' @export
key.scscat <- function(x, ...) if (missing(x)) return(c("date", "tow.id", "species")) else return(gulf.metadata::key.default(x))

#' @describeIn key Fetch \code{scsbio} index key.
#' @export key.scsbio
#' @export
key.scsbio <- function(x, ...) if (missing(x)) return(c("date", "tow.id", "crab.number")) else return(gulf.metadata::key.default(x))

#' @describeIn key Fetch \code{scslen} index key.
#' @export key.scslen
#' @export
key.scslen <- function(x, ...) if (missing(x)) return(NULL) else return(gulf.metadata::key.default(x))

#' @describeIn key Fetch \code{star.oddi} index key.
#' @export key.star.oddi
#' @rawNamespace S3method(key,star.oddi)
key.star.oddi <- function(x, ...) if (missing(x)) return(c("date", "time")) else return(gulf.metadata::key.default(x))

#' @describeIn key Fetch \code{esonar} index key.
#' @export key.esonar
#' @export
key.esonar <- function(x, ...) if (missing(x)) return(c("date", "time")) else return(gulf.metadata::key.default(x))