R/convertSugarCodes_new.R

In SWS-Methodology/faoswsStandardization: Package to perform standardization of SUA (supply utilization account) data to FBS level

##' Converts sugar codes 23511.01 and 23512 to 2351f
##' 
##' 
##' This function harmonize sugar codes. 
##' Raw cane and beet sugar are considered as separate codes in some domain, like trade, because sugar raw can be traded
##' as beet raw, cane raw or just raw (23511.01, 23512 or 2351f), 
##' but when one has to go from the processed product to the primary product, 
##' is not possible to know if a code 2351f has to be standardized to cane or beet, therefore 
##' in the standardization process cane and beet have to be considered as a unique code (2351f)
##' This function makes checks and harmonize sugar codes 
##'  
##' 
##' @param data the downloaded data from sua
##' @return A data.table with the data fixed for sugar
##' @export
##' 

convertSugarCodes_new <- function(data) {
  d <- copy(data)

  # Keep name as it can be measuredItemFbsSua or measuredItemFbsSua (why????)
  item_name <- names(d)[grepl("Item", names(d))]

  setnames(d, item_name, "item")

  sugar <- d[item %in% c('23511.01', '23512', '2351f')]

  sugar <- sugar[order(geographicAreaM49, measuredElementSuaFbs, timePointYears, -item)]

  stock_elem_lab <-
    unique(d$measuredElementSuaFbs)[grep("5071|stock_change|stockChange", unique(d$measuredElementSuaFbs))]

  if (length(stock_elem_lab) > 0) {
    sugar_stock <- sugar[measuredElementSuaFbs == stock_elem_lab]
    sugar <- sugar[measuredElementSuaFbs != stock_elem_lab]
  } else {
    sugar_stock <- d[0]
  }

  if ("residual" %in% sugar$measuredElementSuaFbs) {
    sugar_resid <- sugar[measuredElementSuaFbs == "residual"]
    sugar <- sugar[measuredElementSuaFbs != "residual"]
  } else {
    sugar_resid <- d[0]
  }


  if (nrow(sugar) == 0) {
    return(d)
  }

  sugar[,
      n := .N,
      by = c('geographicAreaM49', 'measuredElementSuaFbs', 'timePointYears')
  ]

  sugar[,
      Value_max := max(Value[item == "2351f"], sum(Value[item %in% c('23511.01', '23512')])),
      by = c('geographicAreaM49', 'measuredElementSuaFbs', 'timePointYears')
  ]

  data("flagWeightTable", package = "faoswsFlag")

  sugar[
    n > 0,
    `:=`(
      flag_obs =
        ifelse(
          "2351f" %in% item[Value == Value_max],
          flagObservationStatus[Value == Value_max],
          faoswsFlag::aggregateObservationFlag(flagObservationStatus[item != "2351f"])
        ),
      flag_meth =
        ifelse(
          "2351f" %in% item[Value == Value_max],
          flagMethod[Value == Value_max],
          ifelse(all(c('23511.01', '23512') %in% item), 's', flagMethod[item != "2351f"])
        )
    ),
      by = c('geographicAreaM49', 'measuredElementSuaFbs', 'timePointYears')
  ]

  sugar_summ <-
    sugar[,
      .(
        Value = max(Value[item == "2351f"], sum(Value[item %in% c('23511.01', '23512')])),
        flagObservationStatus = unique(flag_obs),
        flagMethod = unique(flag_meth),
        item = '2351f'
      ),
      by = c('geographicAreaM49', 'measuredElementSuaFbs', 'timePointYears')
    ]

  res <-
    rbind(
      d[!(item %in% c('23511.01', '23512', '2351f'))],
      sugar_summ,
      sugar_stock,
      sugar_resid
    )

  setnames(res, "item", item_name)

  return(res)
}