R/to_px5.R

In gibonet/df2px: Convert a Data Cube from Data Frame to px File

#' @rdname to_px
#' @inheritParams to_px2
#' 
#' @param CONTENTS character vector of length one with a short description of the content (default = "unknown")
#' @param MATRIX name of the 'data' (default = "unknown")
#' @param SUBJECT_AREA name of the subject area (default = "unknown")
#' @param SUBJECT_CODE subject area code (default = "unknown")
#' @param UNITS unit text (default = "unknown")
#' @param AGGREGALLOWED if the contents can or cannot be aggregated ("YES" or "NO", default = "NO")
#' @param SOURCE the organization responsible for the statistics (default = NULL)
#' @param SURVEY name of the survey (default = NULL)
#' @param REFPERIOD periods of the statistics (default = NULL)
#' @param NOTE character vector with one or more notes. Every element of the character vector will be a row of notes (default = NULL)
#' 
#' 
#' @examples 
#' # to_px2 considers 2 types of 'special' data (missing or other). This information
#' # is retrieved from the 'info' column of the data cube.
#' table(c09C$info)
#' c09C_px2 <- to_px2(.cube = c09C, 
#'                  vars = colnames(c09C)[1:4], 
#'                  measure_vars = colnames(c09C)[5:10],
#'                  measure_name = "misura")
#'                  
#' head(c09C_px2, n = 50)
#' 
#' @export
to_px5 <- function(.cube, vars, measure_vars, measure_name = NULL, 
                   .symbols = c("X", "...", "()"), TITLE = "Title unknown",
                   PRECISION = NULL, SHOWDECIMALS = 0, info = "info",
                   CONTENTS = "unknown", MATRIX = "unknown",
                   SUBJECT_AREA = "unknown", SUBJECT_CODE = "unknown",
                   UNITS = "unknown", AGGREGALLOWED = "NO",
                   SOURCE = NULL, SURVEY = NULL, REFPERIOD = NULL,
                   NOTE = NULL){
  livelli_variabili <- lapply(.cube[ , rev(vars)], function(x) as.character(unique(x)))
  
  # 1. Creazione STUB
  s01 <- add_quotes(vars)
  s02 <- riduci_virgole(s01)
  STUB <- paste0("STUB=", s02, ";")
  
  # 2. Creazione HEADING
  if(is.null(measure_name)){
    HEADING <- NULL
  }else{
    h01 <- add_quotes(measure_name)
    HEADING <- paste0("HEADING=", h01, ";")
  }
  
  # 3. Creazione VALUES
  v01 <- lapply(livelli_variabili, add_quotes)
  v02 <- lapply(v01, riduci_virgole)
  
  if(is.null(measure_name)){
    v03 <- NULL
  }else{
    v03 <- paste0("VALUES(", add_quotes(measure_name), ")=", 
                  riduci_virgole(add_quotes(measure_vars)), ";")
  }
  
  v04 <- lapply(rev(vars), add_quotes)
  
  VALUES <- paste0("VALUES(", v04, ")=", v02, ";")
  VALUES <- c(v03, VALUES)
  
  if(is.null(PRECISION)){
    PRECISION <- NULL
  }else{
    # PRECISION = c("misura", "ETP")
    PRECISION <- paste(add_quotes(PRECISION), collapse = ", ")
    PRECISION <- paste0("PRECISION(", PRECISION, ")=4;")
  }
  
  
  # 4. Creazione DATA
  DATA <- .cube[ , measure_vars, drop = FALSE]
  info <- .cube[[info]]  # colonna 'info' del cubo in formato semi-tidy
  
  if(!is.na(.symbols[1])){
    k_X <- info == .symbols[1]
    DATA[k_X, ] <- "\"..\""
  }
  if(!is.na(.symbols[2])){
    k_dots <- info == .symbols[2]
    DATA[k_dots, ] <- "\"...\""
  } 
  # DATA[] <- lapply(DATA, round)
  DATA <- Reduce(paste, DATA)
  # DATA <- gsub("NA", "\"..\"", DATA)
  DATA <- c("DATA=", DATA, ";")
  
  # 4.1 DATASYMBOL2 e DATASYMBOL3
  DATASYMBOL2 <- paste0("DATASYMBOL2=", add_quotes(.symbols[1]), ";")
  DATASYMBOL3 <- paste0("DATASYMBOL3=", add_quotes(.symbols[2]), ";")
  
  # 4.2 Eventuali DATANOTECELL e DATASYMBOL5
  k_par <- which(info == .symbols[3])
  if(length(k_par) == 0L){
    DATANOTECELLS <- NULL
    DATASYMBOL5 <- NULL
  }else{
    DATANOTECELLS_data <- .cube[k_par, c(vars, measure_name), drop = FALSE]
    DATANOTECELLS <- vector(mode = "character", length = length(k_par))
    
    # Provo con una DATANOTECELL
    DATANOTECELLS_data[] <- lapply(DATANOTECELLS_data, as.character)
    for(i in seq_along(DATANOTECELLS)){
      DATANOTECELLS[i] <- paste0("DATANOTECELL(", 
                                 riduci_virgole(add_quotes(DATANOTECELLS_data[i, ])),
                                 ")=", add_quotes(.symbols[3]), ";")
    }
    
    DATASYMBOL5 <- paste0("DATASYMBOL5=", add_quotes(.symbols[3]), ";")
  }
  
  
  # 5. Assemblamento 1-4. più le keywords "fisse" (per il momento)
  #    in un vettore character che in pratica costituisce il file
  #    .px
  creation_date <- gsub(pattern = "-", replacement = "", x = Sys.time())
  creation_date <- substr(creation_date, 1, 14)
  
  last_updated <- gsub(pattern = "-", replacement = "", x = Sys.time())
  
  if(is.null(SOURCE)){
    SOURCE <- NULL
  }else{
    SOURCE <- add_quotes(SOURCE)
    SOURCE <- paste0("SOURCE=", SOURCE, ";")
  }
  
  if(is.null(SURVEY)){
    SURVEY <- NULL
  }else{
    SURVEY <- add_quotes(SURVEY)
    SURVEY <- paste0("SURVEY=", SURVEY, ";")
  }
  
  if(is.null(REFPERIOD)){
    REFPERIOD <- NULL
  }else{
    REFPERIOD <- add_quotes(REFPERIOD)
    REFPERIOD <- paste0("REFPERIOD=", REFPERIOD, ";")
  }
  
  if(is.null(NOTE)){
    NOTE <- NULL
  }else{
    NOTE <- add_quotes(NOTE)
    NOTE <- paste0("NOTE=", NOTE, ";")
    # NOTE[length(NOTE)] <- paste0(NOTE[length(NOTE)], ";")
  }
  
  
  TITLE <- add_quotes(TITLE)
  TITLE <- paste0(TITLE, ";")
  
  CONTENTS <- add_quotes(CONTENTS)
  CONTENTS <- paste0(CONTENTS, ";")
  
  MATRIX <- add_quotes(MATRIX)
  MATRIX <- paste0(MATRIX, ";")
  
  SUBJECT_AREA <- add_quotes(SUBJECT_AREA)
  SUBJECT_AREA <- paste0(SUBJECT_AREA, ";")
  
  SUBJECT_CODE <- add_quotes(SUBJECT_CODE)
  SUBJECT_CODE <- paste0(SUBJECT_CODE, ";")
  
  UNITS <- add_quotes(UNITS)
  UNITS <- paste0(UNITS, ";")
  
  AGGREGALLOWED <- add_quotes(AGGREGALLOWED)
  AGGREGALLOWED <- paste0(AGGREGALLOWED, ";")
  
  keywords01 <- c("CHARSET=\"ANSI\";", "AXIS-VERSION=\"2000\";", 
                  paste0("CREATION-DATE=\"", creation_date, "\";"),
                  "DECIMALS=11;", paste0("SHOWDECIMALS=", SHOWDECIMALS, ";"),
                  paste0("MATRIX=", MATRIX),
                  paste0("AGGREGALLOWED=", AGGREGALLOWED),
                  paste0("SUBJECT-CODE=", SUBJECT_CODE),
                  paste0("SUBJECT-AREA=", SUBJECT_AREA),
                  paste0("DESCRIPTION=", TITLE),
                  paste0("TITLE=", TITLE), 
                  paste0("CONTENTS=", CONTENTS),
                  paste0("UNITS=", UNITS)
                  )
  keywords02 <- c(paste0("LAST-UPDATED=\"", last_updated, "\";"),
                  "INFO=\"File generated using R\";")
  res <- c(
    keywords01,
    STUB,
    HEADING,
    VALUES,
    PRECISION,
    SOURCE,
    SURVEY,
    NOTE,
    keywords02,
    REFPERIOD,
    DATASYMBOL2,
    DATASYMBOL3,
    DATASYMBOL5,
    DATANOTECELLS,
    DATA
  )
  
  res
}