R/write_rise_json.R

In BoulderCodeHub/rdf2rise: Translate rdf Files to RISE json Files

#' Write the RISE json object to disk
#'
#' `write_rise_json()` takes the json character object and writes the data to
#' the specified location. RISE requires a file format named
#' sourceCode_YYYYMMDDHHMMSSMS.json, so this function creates a file following
#' that naming convention. `sourceCode` is a field that exists in the json
#' character object, so it is used for the file name.
#'
#' @param x json character vector. Likely output from [`tbl_to_rise_json()`].
#'
#' @param path File path to save the file to. Should be an existing directory.
#'
#' @return Invisibly returns `x`. Saves `x` to `path` as .json file.
#'
#' @examples
#' ifile <- system.file(
#'   'extdata/Scenario/ISM1988_2014,2007Dems,IG,Most',
#'   "KeySlots.rdf",
#'  package = "RWDataPlyr"
#' )
#'
#' # get the tbl using RWDataPlyr
#' rwtbl <- RWDataPlyr::rdf_to_rwtbl2(
#'   ifile,
#'   scenario = "test",
#'   keep_cols = rwtbl_cols_for_rise
#' )
#'
#' # manually specify some parameters:
#' ui_vars <- list(
#'   sourceCode = "CRSS-TestData",
#'   modelNameSourceCode = "CRSS",
#'   status = "Finalized Dec. 2012. To RISE v0.0.1",
#'   modelRunDescription = "desc"
#' )
#'
#' # get the rest of the parameters automatically
#' rise_tbl <- rwtbl_add_rise_vars(rwtbl, ui_vars)
#'
#' # and then convert to the RISE json format
#' rise_json <- tbl_to_rise_json(rise_tbl)
#'
#' # finally write the file
#' write_rise_json(rise_json, path = tempdir())
#'
#' @export

write_rise_json <- function(x, path)
{
  assert_that(length(path) == 1)
  assert_that(is.character(path))
  assert_that(dir.exists(path))
  assert_that(length(x) == 1)
  assert_that(is.character(x))

  # sourceCode does not vary by object, so get the first sourceCode object
  # and its value
  source_code <- parse_sourceCode(x)

  time_stamp <- Sys.time()
  # get the mili seconds
  time_stamp_ms <- parse_ms(time_stamp)
  # collapse together
  time_stamp <- collapse_time(time_stamp, time_stamp_ms)

  write(x, file.path(path, paste0(source_code, "_", time_stamp, ".json")))

  invisible(x)
}

# gets the miliseconds from the time and returns it as astring
parse_ms <- function(x)
{
  assert_that(length(x) == 1)

  ms <- round(as.numeric(x) * 100, 0) %% 100
  ms <- as.character(ms) %>%
    stringr::str_pad(2, pad = "0")
  ms
}

# takes the time and collapse down to yyyymmddhhmmss and appends ms
collapse_time <- function(x, ms)
{
  assert_that(length(x) == 1)

  strftime(x) %>%
    stringr::str_remove_all("-") %>%
    stringr::str_remove_all(" ") %>%
    stringr::str_remove_all(":") %>%
    paste0(ms)
}

# from the massive json string, get the first occurrence of the sourceCode
parse_sourceCode <- function(x)
{
  assert_that(length(x) == 1)

  stringr::str_extract(x, 'sourceCode\\"\\:\\"([^\\,]+)') %>%
    # now just key the value
    stringr::str_extract('\\:\\"([^\\,]+)') %>%
    stringr::str_replace_all(':', '') %>%
    stringr::str_replace_all('\\"', '')
}