R/fields.R

In rspacer: 'RSpace' API Wrapper

# Functions to process RSpace structured document fields

data_frame_to_fields <- function(fields_df) {
  col_names <- colnames(fields_df)

  # Convert each row of the data frame into a list using the column names
  fields <- apply(fields_df, 1, function(row) {
    row_list <- as.list(row)
    names(row_list) <- col_names
    row_list
  })
  fields <- as.list(fields)
  return(fields)
}

fields_to_data_frame <- function(fields) {
  tibble::tibble(fields = fields) |> tidyr::unnest_wider("fields")
}

doc_get_fields <- function(doc_id, api_key = get_api_key()) {
  doc <- document_retrieve(doc_id, api_key)
  fields_to_data_frame(doc$fields)
}

#' Put a list of all fields into one field.
#'
#' This can be needed when no Structured Document template is specified and a
#' Basic Document is used, but the html/excel/other input has multiple
#' subheaders or fields.
#'
#' @keywords internal
#' @param doc_body_fields multiple fields in a list
#' @param use_html_sep If `TRUE`, each field is placed in a html paragraph
#' @returns a list with one field, with only content, all contents from other fields, separated by `\n`.
put_all_fields_in_one_field <- function(doc_body_fields, use_html_sep = TRUE) {
  text_content <- fields_to_data_frame(doc_body_fields)

  if (use_html_sep) {
    text_content <- text_content |>
      dplyr::mutate(content = paste0("<p>", as.character(.data$content), "</p>"))
  }
  # Collapse content into one field
  text_content <- text_content |>
    dplyr::pull(.data$content) |>
    paste(collapse = "\n")

  return(list(list("content" = text_content)))
}