R/df-to-json.R

In Sage-Bionetworks/dccvalidator: Metadata Validation for Data Coordinating Centers

#' Convert data frame to JSON
#'
#' Given a data frame, converts each row to a JSON blob and returns the results
#' in a list, to make it easier to iteratively validate data with
#' [check_schema_df()].
#'
#' @param df A data frame
#' @return A list of JSON blobs
#' @export
#' @seealso check_schema
#' @examples
#' if (requireNamespace("jsonlite", quietly = TRUE)) {
#'   dat <- data.frame(
#'     x = c(NA, 1L)
#'   )
#'   df_to_json_list(dat)
#' }
df_to_json_list <- function(df) {
  if (!requireNamespace("jsonlite", quietly = TRUE)) {
    stop(
      "Package \"jsonlite\" needed for this function to work. Please install it.", # nolint
      call. = FALSE
    )
  }
  result <- vector("list", nrow(df))
  for (i in seq_len(nrow(df))) {
    result[[i]] <- jsonlite::toJSON(jsonlite::unbox(df[i, , drop = FALSE]))
  }
  result
}