R/fstat_GetTimeseries.R

In bergertom/fishstatr: fishstatr: an R package to access fishstat reference data from EBX5

#' @title Get FishStat Timeseries
#'
#' @description This is a convenience function to make it easier to get started using data
#' from EBX5. It provides a timeseries name, and the Timeseries-Identifier required by other functions.
#'
#' @param metadata FishStat metadata; obtained using \code{\link{ReadMetadata}}
#'
#'
#' @return Returns an object of the class \code{\link[data.table]{data.table}}
#'
#' @import data.table
#'
#' @export
#'
#' @author Thomas Berger, \email{thomas.berger@fao.org}
GetTimeseries <- function(metadata) {

  if (!is.list(metadata) || length(names(metadata))!=13 || !is.data.frame(metadata$Dataset)) {
    stop('metadata is not valid for FishStat')
  }

  return(metadata$Timeseries[metadata$Timeseries$isFishStatJ=='true',c('Identifier','Acronym','Name_En','Description_En','DatasetKey')])
}