R/dataset-docs.R

In MikkoVihtakari/MarineDatabase: Export data to Norwegian Polar Institute's marine database

#' @name ctd_rijpfjord
#' @title Example CTD data for Rijpfjorden
#' @description A dataframe containing example CTD data for Rijpfjorden. 
#' @docType data
#' @usage data("ctd_rijpfjord")
#' @format data.frame 
NULL

#' @name ctd_kongsfjord
#' @title Example CTD data for Kongsfjorden
#' @description A dataframe containing example CTD data for Kongsfjorden. 
#' @docType data
#' @usage data("ctd_kongsfjord")
#' @format data.frame 
NULL

#' @name rijpfjord_watermasses
#' @title Water mass definitions for Rijpfjorden
#' @description A dataframe containing water mass definitions for Rijpfjorden. 
#' @docType data
#' @usage data("rijpfjord_watermasses")
#' @format data.frame 
NULL

#' @name kongsfjord_watermasses
#' @title Water mass definitions for Kongsfjorden
#' @description A dataframe containing water mass definitions for Kongsfjorden. An example of formatting of the \code{WM} argument in \code{\link{define_water_type}}
#' @docType data
#' @usage data("kongsfjord_watermasses")
#' @format data.frame 
NULL

#' @name GEAR
#' @title Gear types
#' @description A dataframe containing allowed gear types.
#' @docType data
#' @usage data("gear_types")
#' @format data.frame 
NULL


#' @name TYPES
#' @title Data types
#' @description A dataframe containing allowed sample codes.
#' @docType data
#' @usage data("sample_types")
#' @format data.frame 
NULL

#' @name STATIONS
#' @title Standardized station names
#' @description A dataframe containing standardized station names.
#' @docType data
#' @usage data("stations")
#' @format data.frame 
NULL

#' @name ZOOPL
#' @title Standardized zooplankton species names
#' @description A dataframe containing standardized zooplankton species names. 
#' 
#' \itemize{
#' \item The "species", "stage", "length", "size_op" and "length_old" columns are used in species name matching (\code{\link{read_zooplankton_data}}). 
#' \item The "species_ID" column contains unique standardized species names: 
#'  \itemize{
#'  \item Capital letters in the beginning of the string refer to genus and higher ranks, while lower case letters indicate species names. 
#'  \item Numbers refer to either stage or length. character "t" means range (from Y to X, where Y and X are lengths in millimetres.). 
#'  \item Lower case strings "zoe", "meg", "naup", "calyp", "med", "pil", "vel", and "lar" are used for various larval forms. 
#'  \item Lower case "juv" is used for juveniles. 
#'  \item "FM" and "AM" refer to adult females and males, respectively. 
#'  }
#' }
#' @docType data
#' @usage data("ZOOPL")
#' @format data.frame 
NULL