Support pagination of lists of rtables/rlistings objects

NEWS.md

@@ -10,6 +10,7 @@
  * Fixed mismatch between pagination and exports regarding the value assigned to parameter `max_width`. Introduced general handler `.handle_max_width` for pagination, exports, and `toString`.
  * Fixed bug in `format_value` causing a warning for vectors containing both NA and non-NA values.
  * Fixed issue with `var_label` assignment that needed to be of non-named strings.
+ * Updated `export_as_txt` to allow lists of tables/listings as input. This enables listing pagination with pages by parameter.
 
 ## formatters 0.5.5
  * Applied `styler` and resolved package lint. Changed default indentation from 4 spaces to 2.

R/matrix_form.R

@@ -286,6 +286,7 @@ MatrixPrintForm <- function(strings = NULL,
                             main_title = "",
                             subtitles = character(),
                             page_titles = character(),
+                            listing_keycols = NULL,
                             main_footer = "",
                             prov_footer = character(),
                             header_section_div = NA_character_,
@@ -315,6 +316,7 @@ MatrixPrintForm <- function(strings = NULL,
       header_section_div = header_section_div,
       horizontal_sep = horizontal_sep,
       col_gap = col_gap,
+      listing_keycols = listing_keycols,
       table_inset = as.integer(table_inset),
       has_topleft = has_topleft,
       indent_size = indent_size,
@@ -915,8 +917,12 @@ basic_matrix_form <- function(df, parent_path = "root", ignore_rownames = FALSE,
     has_topleft = FALSE,
     nlines_header = 1,
     nrow_header = 1,
-    has_rowlabs = TRUE
+    has_rowlabs = isFALSE(ignore_rownames)
   )
+
+  # Check for ncols
+  stopifnot(mf_has_rlabels(ret) == isFALSE(ignore_rownames))
+
   ret <- mform_build_refdf(ret)
 
   if (add_decoration) {
@@ -936,7 +942,7 @@ basic_matrix_form <- function(df, parent_path = "root", ignore_rownames = FALSE,
 #'
 #' @param keycols character. Vector of `df` column names that are printed first and
 #'   repeated values are assigned to `""`. This format is characteristic of a listing matrix form.
-#'   When `NULL`, no key columns are used. Defaults to `c("vs", "gear")` for `mtcars` default dataset.
+#'   When `NULL`, no key columns are used.
 #' @return A valid `MatrixPrintForm` object representing `df` as a listing,
 #'   ready for ASCII rendering.
 #'
@@ -946,7 +952,7 @@ basic_matrix_form <- function(df, parent_path = "root", ignore_rownames = FALSE,
 #'
 #' @export
 basic_listing_mf <- function(df,
-                             keycols = c("vs", "gear"),
+                             keycols = names(df)[1], # c("vs", "gear")
                              ignore_rownames = FALSE,
                              add_decoration = TRUE) {
   checkmate::assert_data_frame(df)
@@ -958,6 +964,9 @@ basic_listing_mf <- function(df,
     add_decoration = add_decoration
   )
 
+  # keycols addition to MatrixPrintForm (should happen in the constructor)
+  dfmf$listing_keycols <- keycols
+
   # Modifications needed for making it a listings
   mf_strings(dfmf)[1, ] <- colnames(mf_strings(dfmf)) # set colnames
 
@@ -994,7 +1003,8 @@ basic_listing_mf <- function(df,
 
   dfmf$aligns[seq(2, nrow(dfmf$aligns)), ] <- "center" # the default for listings
 
-  dfmf$formats[] <- 1 # the default for listings is numeric??
+  # the default for listings is a 1 double??
+  dfmf$formats <- matrix(1, nrow = nrow(dfmf$formats), ncol = ncol(dfmf$formats))
 
   # row info
   ri <- dfmf$row_info
@@ -1003,11 +1013,23 @@ basic_listing_mf <- function(df,
   ri$path <- as.list(NA_character_) # same format of listings
   ri$node_class <- "listing_df"
   # l_ri$pos_in_siblings # why is it like this in rlistings?? also n_siblings
+  class(ri$path) <- "AsIs" # Artifact from I()
   dfmf$row_info <- ri
 
   # colwidths need to be sorted too!!
   dfmf$col_widths <- dfmf$col_widths[colnames(mf_strings(dfmf))]
 
+  # Adjustment for presence of rownames column
+  # if (isFALSE(ignore_rownames)) {
+  #   attr(dfmf, "ncols") <- attr(dfmf, "ncols") + 1
+  # }
+
+  if (!add_decoration) {
+    # This is probably a forced behavior in the original matrix_form in rlistings
+    main_title(dfmf) <- character()
+    main_footer(dfmf) <- character()
+  }
+
   dfmf
 }
 
@@ -1047,7 +1069,7 @@ reconstruct_basic_fnote_list <- function(mf) {
   tmp_strmat <- mf_strings(mf)[i_mat, j_mat, drop = FALSE]
 
   # Only for listings
-  if (nrow(tmp_strmat) > 0 && .is_listing(mf)) { # safe check for empty listings
+  if (nrow(tmp_strmat) > 0 && .is_listing_mf(mf)) { # safe check for empty listings
 
     # Fix for missing labels in key columns (only for rlistings)
     empty_keycols <- !nzchar(tmp_strmat[-seq_len(nlh), keycols, drop = FALSE][1, ])
@@ -1089,6 +1111,7 @@ reconstruct_basic_fnote_list <- function(mf) {
   } else {
     newspans <- mf_spans(mf)[i_mat, j_mat, drop = FALSE]
   }
+
   mf_spans(mf) <- newspans
   mf_formats(mf) <- mf_formats(mf)[i_mat, j_mat, drop = FALSE]
 

R/mpf_exporters.R

@@ -58,10 +58,17 @@
                           colwidths = NULL,
                           min_siblings = 2,
                           nosplitin = character(),
-                          rep_cols = num_rep_cols(x),
+                          rep_cols = NULL,
                           verbose = FALSE,
                           page_break = "\\s\\n",
                           page_num = default_page_number()) {
+  # Processing lists of tables or listings
+  if (.is_list_of_tables_or_listings(x)) {
+    if (isFALSE(paginate)) {
+      warning("paginate is FALSE, but x is a list of tables or listings, so paginate will automatically be updated to TRUE")
+    }
+    paginate <- TRUE
+  }
 
   if (paginate) {
     pages <- paginate_to_mpfs(
@@ -101,7 +108,7 @@
     )
   }
 
-  ## we dont' set widths here because we already but that info on mpf
+  ## we don't set widths here because we already put that info in mpf
   ## so its on each of the pages.
   strings <- vapply(
     pages, toString, "",
@@ -118,7 +125,22 @@
   }
 }
 
+.is_list_of_tables_or_listings <- function(a_list) {
+  all_matrix_forms <- FALSE
+  obj_are_tables_or_listings <- FALSE
 
+  if (is(a_list[[1]], "MatrixPrintForm")) {
+    all_matrix_forms <- all(sapply(a_list, is, class2 = "MatrixPrintForm"))
+  } else {
+    obj_are_tables_or_listings <- all(
+      sapply(a_list, function(list_i) {
+        is(list_i, "listing_df") || is(list_i, "VTableTree")
+      })
+    )
+  }
+
+  is(a_list, "list") && (obj_are_tables_or_listings || all_matrix_forms)
+}
 
 ##     ## TODO this needs to be in terms of a MPF, so ncol(tt) needs to change
 
@@ -416,7 +438,7 @@
 
 export_as_rtf <- function(x,
                           file = NULL,
-                          colwidths = propose_column_widths(matrix_form(x, TRUE)),
+                          colwidths = NULL,
                           page_type = "letter",
                           pg_width = page_dim(page_type)[if (landscape) 2 else 1],
                           pg_height = page_dim(page_type)[if (landscape) 1 else 2],
@@ -425,27 +447,26 @@
                           font_size = 8,
                           font_family = "Courier",
                           ...) {
+  # Processing lists of tables or listings
+  if (.is_list_of_tables_or_listings(x)) {
+    if (isFALSE(paginate)) {
+      warning("paginate is FALSE, but x is a list of tables or listings, so paginate will automatically be updated to TRUE")
+    }
+    paginate <- TRUE
+  }
+
   if (!requireNamespace("r2rtf")) {
     stop("RTF export requires the r2rtf package, please install it.")
   }
   if (is.null(names(margins))) {
     names(margins) <- marg_order
   }
 
-  fullmf <- matrix_form(x, indent_rownames = TRUE)
-  req_ncols <- ncol(fullmf) + as.numeric(mf_has_rlabels(fullmf))
-  if (!is.null(colwidths) && length(colwidths) != req_ncols) {
-    stop(
-      "non-null colwidths argument must have length ncol(x) (+ 1 if row labels are present) [",
-      req_ncols, "], got length ", length(colwidths)
-    )
-  }
-
   true_width <- pg_width - sum(margins[c("left", "right")])
   true_height <- pg_height - sum(margins[c("top", "bottom")])
 
   mpfs <- paginate_to_mpfs(
-    fullmf,
+    x,
     font_family = font_family, font_size = font_size,
     pg_width = true_width,
     pg_height = true_height,
@@ -543,16 +564,20 @@
                           cpp = NULL,
                           hsep = "-",
                           indent_size = 2,
+                          rep_cols = num_rep_cols(x),
                           tf_wrap = TRUE,
                           max_width = NULL,
-                          colwidths = propose_column_widths(x)) {
+                          colwidths = NULL) {
   stopifnot(tools::file_ext(file) != ".pdf")
-  if (!is.null(colwidths) && length(colwidths) != ncol(x) + 1) {
-    stop(
-      "non-null colwidths argument must have length ncol(x) + 1 [",
-      ncol(x) + 1, "], got length ", length(colwidths)
-    )
+
+  # Processing lists of tables or listings
+  if (.is_list_of_tables_or_listings(x)) {
+    if (isFALSE(paginate)) {
+      warning("paginate is FALSE, but x is a list of tables or listings, so paginate will automatically be updated to TRUE")
+    }
+    paginate <- TRUE
   }
+
   gp_plot <- grid::gpar(fontsize = font_size, fontfamily = font_family)
 
   if (!is.null(height)) {
@@ -604,7 +629,7 @@
       max_width = max_width,
       indent_size = indent_size,
       verbose = FALSE,
-      rep_cols = num_rep_cols(x),
+      rep_cols = rep_cols,
       page_num = page_num
     )
   } else {