R/fstat_ReadMetadata.R

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

#' @title Read FishStat Metadata
#'
#' @description This function returns the FishStat metadata which is used for subsequent operations
#'
#' @return The returned object is used by other methods
#'
#' @importFrom faoebx5 EBXRead
#' @import data.table
#'
#' @examples
#' \dontrun{
#' library(faoebx5)
#' library(fishstatr)
#' metadata <- ReadMetadata()
#' }
#'
#' @export
#'
#' @author Thomas Berger, \email{thomas.berger@fao.org}
ReadMetadata <- function() {


  fsj_Workspace  <- ReadEBXCodeList('FSJ_WORKSPACE')
  fsj_Dataset    <- ReadEBXCodeList('FSJ_DATASET')
  fsj_Timeseries <- ReadEBXCodeList('FSJ_TIMSERIES')

  fsj_Concept   <- ReadEBXCodeList('FSJ_CONCEPT')
  fsj_Dimension <- ReadEBXCodeList('FSJ_DIMENSION')
  fsj_Relation  <- ReadEBXCodeList('FSJ_RELATION')
  fsj_Attribute <- ReadEBXCodeList('FSJ_ATTRIBUTE')
  fsj_Measure   <- ReadEBXCodeList('FSJ_MEASURE')
  fsj_Unit      <- ReadEBXCodeList('FSJ_UNIT')
  fsj_Period    <- ReadEBXCodeList('FSJ_PERIOD')

  fsj_Workspace2Dataset <- ReadEBXGroup('HCL_FSJ_WORKSPACE_DATASET')
  fsj_Dataset2Concept   <- ReadEBXGroup('HCL_FSJ_DATASET_CONCEPT')
  fsj_Dataset2Relation  <- ReadEBXGroup('HCL_FSJ_DATASET_RELATION')

  fsj_Metadata <- list('Workspace'  = fsj_Workspace,
                       'Dataset'    = fsj_Dataset,
                       'Timeseries' = fsj_Timeseries,
                       'Concept'    = fsj_Concept,
                       'Dimension'  = fsj_Dimension,
                       'Relation'   = fsj_Relation,
                       'Attribute'  = fsj_Attribute,
                       'Measure'    = fsj_Measure,
                       'Unit'       = fsj_Unit,
                       'Period'     = fsj_Period,
                       'Workspace2Dataset' = fsj_Workspace2Dataset,
                       'Dataset2Concept'   = fsj_Dataset2Concept,
                       'Dataset2Relation'  = fsj_Dataset2Relation)

  return(fsj_Metadata)
}