R/getSurveyList.R

Defines functions getSurveyList

Documented in getSurveyList

#' Get a List of All Surveys
#'
#' Get a list of all survey acronyms.
#'
#' @return A character vector.
#'
#' @seealso
#' \code{\link{getSurveyYearList}}, \code{\link{getSurveyYearQuarterList}}, and
#' \code{\link{getDatrasDataOverview}} also list available data.
#'
#' \code{\link{icesDatras-package}} gives an overview of the package.
#'
#' @author Colin Millar.
#'
#' @examples
#' \dontrun{
#' getSurveyList()
#' }
#' @export

getSurveyList <- function() {
  # check web services are running
  if (!checkDatrasWebserviceOK()) return (FALSE)

  # read url and parse to data frame
  url <- "https://datras.ices.dk/WebServices/DATRASWebService.asmx/getSurveyList"
  out <- readDatras(url)
  out <- parseDatras(out)

  out$Survey
}
ices-tools-prod/icesDatras documentation built on March 27, 2024, 11:29 p.m.