reforked

Merge branch 'main' of https://github.com/iaugusty/formatters

# Conflicts:
#	DESCRIPTION
#	NEWS.md

Author: iaugusty

.Rbuildignore

@@ -1,3 +1,5 @@
+^renv$
+^renv\.lock$
 (^|/)[#][^/]*#$
 (^|/)\.[#][^/]*$
 ^.*\.Rproj$

.github/workflows/check.yaml

@@ -40,6 +40,27 @@ jobs:
         checking top-level files .* NOTE
       unit-test-report-brand: >-
         https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/thumbs/formatters.png
+  r-cmd-non-cran:
+    name: R CMD Check (non-CRAN) 🧬
+    uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main
+    secrets:
+      REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
+    with:
+      enforce-note-blocklist: true
+      publish-unit-test-report-gh-pages: false
+      junit-xml-comparison: false
+      concurrency-group: non-cran
+      disable-unit-test-reports: true
+      skip-r-cmd-install: true
+      note-blocklist: |
+        checking dependencies in R code .* NOTE
+        checking R code for possible problems .* NOTE
+        checking examples .* NOTE
+        checking Rd line widths .* NOTE
+        checking S3 generic/method consistency .* NOTE
+        checking Rd .usage sections .* NOTE
+        checking for unstated dependencies in vignettes .* NOTE
+        checking top-level files .* NOTE
   coverage:
     name: Coverage 📔
     uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main

.pre-commit-config.yaml

@@ -13,6 +13,7 @@ repos:
           - checkmate
           - grid
           - htmltools
+          - lifecycle
     # codemeta must be above use-tidy-description when both are used
     # -   id: codemeta-description-updated
     -   id: use-tidy-description

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: formatters
 Title: ASCII Formatting for Values and Tables
-Version: 0.5.6.9003
-Date: 2024-04-29
+Version: 0.5.6.9006
+Date: 2024-05-27
 Authors@R: c(
     person("Gabriel", "Becker", , "[email protected]", role = "aut",
            comment = "original creator of the package"),
@@ -25,23 +25,23 @@ Depends:
 Imports:
     checkmate (>= 2.1.0),
     grid,
-    htmltools (>= 0.5.3)
+    htmltools (>= 0.5.3),
+    lifecycle (>= 0.2.0)
 Suggests:
     dplyr (>= 1.0.9),
-    gt (>= 0.7.0),
+    gt (>= 0.10.0),
     huxtable (>= 2.0.0),
     knitr (>= 1.42),
-    lifecycle (>= 0.2.0),
     r2rtf (>= 0.3.2),
-    rmarkdown (>= 2.19),
+    rmarkdown (>= 2.23),
     stringi (>= 1.6),
     testthat (>= 3.0.4),
     withr (>= 2.0.0)
 VignetteBuilder:
     knitr
 Config/Needs/verdepcheck: mllg/checkmate, rstudio/htmltools,
-    tidyverse/dplyr, rstudio/gt, hughjonesd/huxtable, yihui/knitr,
-    r-lib/lifecycle, Merck/r2rtf, rstudio/rmarkdown, gagolews/stringi,
+    r-lib/lifecycle, tidyverse/dplyr, rstudio/gt, hughjonesd/huxtable,
+    yihui/knitr, Merck/r2rtf, rstudio/rmarkdown, gagolews/stringi,
     r-lib/testthat, r-lib/withr
 Config/Needs/website: insightsengineering/nesttemplate
 Encoding: UTF-8

NAMESPACE

@@ -158,6 +158,7 @@ importFrom(grid,textGrob)
 importFrom(grid,unit)
 importFrom(htmltools,tagList)
 importFrom(htmltools,tags)
+importFrom(lifecycle,deprecated)
 importFrom(stats,na.omit)
 importFrom(tools,file_ext)
 importFrom(utils,capture.output)

NEWS.md

@@ -1,4 +1,8 @@
-## formatters 0.5.6.9003
+## formatters 0.5.6.9006
+
+* Deprecate `width`, `height` and `fontsize` arguments of `export_as_pdf()` using `lifecycle` package.
+* Add `lifecycle` badge files for documentation.
+* Fixed bug causing recursive appending of page number text during pagination.
 
 ## formatters 0.5.6
  * Added "N=xx" format and unit test for it.
@@ -50,7 +54,7 @@
  * Reduced the amount of spelling issues.
  * New generic `getter` and `setter` for `align` (`obj_align` and `obj_align<-`).
  * New `fmt_config` class to bundle together `format`, `na_str`, and `align` instructions.
- * Reverting default for alignment (from `NULL` to `center`) and `na_str` 
+ * Reverting default for alignment (from `NULL` to `center`) and `na_str`
    from `NULL` to `"NA"`. This affects only `rlistings`, where the new default takes effect.
 
 ## formatters 0.5.0
@@ -66,7 +70,7 @@
  * `MatrixPrintForm` objects now pay closer attention to referential footnote information than they did in the past.
  * `MatrixPrintForm` objects infer detailed referential footnote information from their `strings` element for backward compatibility.
  * Fix to test that failed on old Windows CRAN machine due to imperfect UTF support there.
- * If `lpp` and `cpp` in pagination or exporter functions are assigned to `NULL`, no pagination in the vertical or horizontal direction happens, respectively. 
+ * If `lpp` and `cpp` in pagination or exporter functions are assigned to `NULL`, no pagination in the vertical or horizontal direction happens, respectively.
  * The new default of `NA_integer_` for `lpp` and `cpp` now means those values should be inferred from page size.
  * Added `hexSticker` logo.
 
@@ -111,10 +115,10 @@
  * adding wrapping of titles, subtitles, and footers.
  * `page_lcpp` function now provided to map page size and font combinations to lines
    and characters per page.
- * `getters` and `setters` for the components of `MatrixPrintForm` objects are now exported 
+ * `getters` and `setters` for the components of `MatrixPrintForm` objects are now exported
    (i.e., `mf_spans` and friends).
  * `na_str` can now be length >1, and is matched in position to NAs in that case.
- * `format_value` now returns solely the `na_str` value when all-NA values are formatted with certain formats 
+ * `format_value` now returns solely the `na_str` value when all-NA values are formatted with certain formats
     (currently`"(N=xx)"`, `">999.9"`, `">999.99"`, `"x.xxxx | (<0.0001)"`)
 
 ## formatters 0.3.3
@@ -147,7 +151,7 @@
 ## formatters 0.3.0
  * add exported `default_hsep` function for use her and in reverse-dependencies (incl `rtables`)
  * format_value now respects `na_str` even when format is `xx` (previously it returned `"NA"` always)
- * rename `linesep` argument to `hsep` in `toString` generic signature 
+ * rename `linesep` argument to `hsep` in `toString` generic signature
  * add `indent_size` argument to `matrix_form` generic signature
  * add a number of `"__ (__)"` (no pct) formats in response to #23
  * Switch to `testthat` as testing framework

R/mpf_exporters.R

@@ -504,13 +504,13 @@ export_as_pdf <- function(x,
                           landscape = FALSE,
                           pg_width = page_dim(page_type)[if (landscape) 2 else 1],
                           pg_height = page_dim(page_type)[if (landscape) 1 else 2],
-                          width = NULL,
-                          height = NULL, # passed to pdf()
+                          width = lifecycle::deprecated(),
+                          height = lifecycle::deprecated(),
                           margins = c(4, 4, 4, 4),
                           min_siblings = 2,
                           font_family = "Courier",
                           font_size = 8,
-                          fontsize = font_size,
+                          fontsize = lifecycle::deprecated(),
                           paginate = TRUE,
                           page_num = default_page_number(),
                           lpp = NULL,
@@ -534,19 +534,21 @@ export_as_pdf <- function(x,
     paginate <- TRUE
   }
 
-  gp_plot <- grid::gpar(fontsize = font_size, fontfamily = font_family)
-
-  if (!is.null(height)) {
-    pg_height <- height
-  }
-
-  if (!is.null(width)) {
+  if (lifecycle::is_present(width)) {
+    lifecycle::deprecate_warn("0.5.5", "export_as_pdf(width)", "export_as_pdf(pg_width)")
     pg_width <- width
   }
-
-  if (missing(font_size) && !missing(fontsize)) {
+  if (lifecycle::is_present(height)) {
+    lifecycle::deprecate_warn("0.5.5", "export_as_pdf(height)", "export_as_pdf(pg_height)")
+    pg_height <- height
+  }
+  if (lifecycle::is_present(fontsize)) {
+    lifecycle::deprecate_warn("0.5.5", "export_as_pdf(fontsize)", "export_as_pdf(font_size)")
     font_size <- fontsize
   }
+
+  gp_plot <- grid::gpar(fontsize = font_size, fontfamily = font_family)
+
   pdf(file = file, width = pg_width, height = pg_height)
   on.exit(dev.off())
   grid::grid.newpage()

R/package.R

@@ -2,10 +2,12 @@
 #'
 #' Package to format tables and listings in a flexible way.
 #'
+#' @keywords internal
 "_PACKAGE"
 
+#' @importFrom htmltools tags tagList
+#' @importFrom lifecycle deprecated
 #' @importFrom stats na.omit
 #' @importFrom utils head tail localeToCharset
-#' @importFrom htmltools tags tagList
 #' @import checkmate
 NULL

R/pagination.R

@@ -1092,7 +1092,7 @@ paginate_to_mpfs <- function(obj,
     return(mpfs)
   }
 
-  if (!is.null(page_num)) {
+  if (!is.null(page_num) && (length(prov_footer(obj)) == 0 || !grepl(page_num, prov_footer(obj), perl = TRUE))) {
     # Only adding a line for pagination -> lpp - 1 would have worked too
     prov_footer(obj) <- c(prov_footer(obj), page_num)
   }
@@ -1167,7 +1167,8 @@ paginate_to_mpfs <- function(obj,
       colwidths = colwidths,
       min_siblings = min_siblings,
       nosplitin = nosplitin,
-      verbose = verbose
+      verbose = verbose,
+      page_num = page_num
     )
     return(unlist(deep_pag, recursive = FALSE))
   } else if (has_page_title(fpags[[1]])) {

inst/WORDLIST

@@ -15,7 +15,6 @@ decrementing
 formatter
 funder
 getters
-glyphs
 mandatorily
 paginations
 pathing