R/labelsGADS.R

In eatGADS: Data Management of Large Hierarchical Data

#### Get Labels from Gads
#############################################################################
#' Labels from relational \code{eatGADS} data base.
#'
#' Returns the variable and value labels of all variables in the \code{eatGADS} data base.
#'
#' Variable, value and missing labels as stored in the original SPSS-files and factors from R files are converted to long format for
#' storage in the data base. \code{labelsGADS} returns them as a long format data frame.
#'
#'@param filePath Path of the existing \code{eatGADS} data base.
#'
#'@return Returns a long format data frame including variable names, labels, values, value labels and missing labels.
#'
#'@examples
#'# Extract Meta data from data base
#'db_path <- system.file("extdata", "pisa.db", package = "eatGADS")
#'metaData <- labelsGADS(db_path)
#'
#'@export
labelsGADS <- function(filePath) {
  eatDB::dbSingleDF(dfName = "Meta_data", filePath = filePath)
}