support df-print option for knitr engine (defaults to kable)

Author: jjallaire

src/config/constants.ts

@@ -19,6 +19,7 @@ export const kFigFormat = "fig-format";
 export const kFigDpi = "fig-dpi";
 
 export const kMermaidFormat = "mermaid-format";
+export const kDfPrint = "df-print";
 
 export const kCache = "cache";
 export const kFreeze = "freeze";
@@ -93,6 +94,7 @@ export const kExecuteDefaultsKeys = [
   kFigFormat,
   kFigDpi,
   kMermaidFormat,
+  kDfPrint,
   kError,
   kEval,
   kEngine,

src/config/types.ts

@@ -46,6 +46,7 @@ import {
   kCrossrefTblTitle,
   kCrossrefThmTitle,
   kCss,
+  kDfPrint,
   kEcho,
   kEngine,
   kEnvironmentProofTitle,
@@ -344,7 +345,8 @@ export interface FormatExecute {
   [kFigHeight]?: number;
   [kFigFormat]?: "retina" | "png" | "jpeg" | "svg" | "pdf";
   [kFigDpi]?: number;
-  [kMermaidFormat]?: "png" | "svg";
+  [kMermaidFormat]?: "png" | "svg" | "js";
+  [kDfPrint]?: "default" | "kable" | "tibble" | "paged";
   [kCache]?: true | false | "refresh" | null;
   [kFreeze]?: true | false | "auto";
   [kExecuteEnabled]?: true | false | null;

src/format/formats-shared.ts

@@ -15,6 +15,7 @@ import {
   kCodeOverflow,
   kCodeTools,
   kDefaultImageExtension,
+  kDfPrint,
   kEcho,
   kError,
   kEval,
@@ -54,6 +55,7 @@ import {
   kLinkExternalIcon,
   kLinkExternalNewwindow,
   kMergeIncludes,
+  kMermaidFormat,
   kOutput,
   kOutputDivs,
   kOutputExt,
@@ -173,6 +175,8 @@ function defaultFormat(): Format {
       [kFigHeight]: 5,
       [kFigFormat]: "png",
       [kFigDpi]: 96,
+      [kMermaidFormat]: undefined,
+      [kDfPrint]: "kable",
       [kError]: false,
       [kEval]: true,
       [kCache]: null,

src/resources/editor/tools/vs-code.mjs

@@ -15594,7 +15594,27 @@ var require_yaml_intelligence_resources = __commonJS({
           description: "Change the presentation direction to be RTL\n"
         }
       ],
-      "schema/document-tables.yml": [],
+      "schema/document-tables.yml": [
+        {
+          name: "df-print",
+          schema: {
+            enum: [
+              "default",
+              "kable",
+              "tibble",
+              "paged"
+            ]
+          },
+          tags: {
+            engine: "knitr"
+          },
+          default: "kable",
+          description: {
+            short: "Method used to print tables in Knitr engine documents (`default`,\n`kable`, `tibble`, or `paged`). Defaults to `kable`.\n",
+            long: "Method used to print tables in Knitr engine documents:\n\n-  `default`: Use the default S3 method for the data frame.\n-  `kable`: Markdown table using the `knitr::kable()` function.\n-  `tibble`: Plain text table using the `tibble` package.\n-  `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n"
+          }
+        }
+      ],
       "schema/document-text.yml": [
         {
           name: "wrap",
@@ -18960,7 +18980,11 @@ var require_yaml_intelligence_resources = __commonJS({
         "Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
         "Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
         "Custom tools for navbar or sidebar",
-        "internal-schema-hack"
+        "internal-schema-hack",
+        {
+          short: "Method used to print tables in Knitr engine documents\n(<code>default</code>, <code>kable</code>, <code>tibble</code>, or\n<code>paged</code>). Defaults to <code>kable</code>.",
+          long: "Method used to print tables in Knitr engine documents:"
+        }
       ],
       "schema/external-schemas.yml": [
         {

src/resources/editor/tools/yaml/web-worker.js

@@ -8573,7 +8573,27 @@
       "description": "Change the presentation direction to be RTL\n"
     }
   ],
-  "schema/document-tables.yml": [],
+  "schema/document-tables.yml": [
+    {
+      "name": "df-print",
+      "schema": {
+        "enum": [
+          "default",
+          "kable",
+          "tibble",
+          "paged"
+        ]
+      },
+      "tags": {
+        "engine": "knitr"
+      },
+      "default": "kable",
+      "description": {
+        "short": "Method used to print tables in Knitr engine documents (`default`,\n`kable`, `tibble`, or `paged`). Defaults to `kable`.\n",
+        "long": "Method used to print tables in Knitr engine documents:\n\n-  `default`: Use the default S3 method for the data frame.\n-  `kable`: Markdown table using the `knitr::kable()` function.\n-  `tibble`: Plain text table using the `tibble` package.\n-  `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n"
+      }
+    }
+  ],
   "schema/document-text.yml": [
     {
       "name": "wrap",
@@ -11939,7 +11959,11 @@
     "Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
     "Download buttons for other formats to include on navbar or sidebar\n(one or more of <code>pdf</code>, <code>epub</code>, and\n<code>docx</code>)",
     "Custom tools for navbar or sidebar",
-    "internal-schema-hack"
+    "internal-schema-hack",
+    {
+      "short": "Method used to print tables in Knitr engine documents\n(<code>default</code>, <code>kable</code>, <code>tibble</code>, or\n<code>paged</code>). Defaults to <code>kable</code>.",
+      "long": "Method used to print tables in Knitr engine documents:"
+    }
   ],
   "schema/external-schemas.yml": [
     {

src/resources/editor/tools/yaml/yaml-intelligence-resources.json

@@ -101,13 +101,20 @@ execute <- function(input, format, tempDir, libDir, dependencies, cwd, params, r
     NULL
   }
 
+  # determine df_print
+  df_print <- format$execute$`df-print`
+  if (df_print == "paged" && !is_html_output(format) && !format$render$`prefer-html`) {
+    df_print <- "kable"
+  }
+
   # synthesize rmarkdown output format
   output_format <- rmarkdown::output_format(
     knitr = knitr,
     pandoc = pandoc_options(format),
     post_knit = post_knit,
     keep_md = FALSE,
-    clean_supporting = TRUE
+    clean_supporting = TRUE,
+    df_print = df_print
   )
 
   # FIXME this test isn't failing in shiny mode, but it doesn't look to be
@@ -137,6 +144,11 @@ execute <- function(input, format, tempDir, libDir, dependencies, cwd, params, r
   else
     character()
 
+  # ammend knit_meta with paged table if df_print == "paged"
+  if (df_print == "paged") {
+    knit_meta <- append(knit_meta, list(rmarkdown::html_dependency_pagedtable()))
+  }
+
   # see if we are going to resolve knit_meta now or later 
   if (dependencies) {
     engineDependencies <- NULL
@@ -470,6 +482,9 @@ extract_preserve_chunks <- function(output_file, format) {
   }
 }
 
+is_html_output <- function(format) {
+  knitr::is_html_output(format$pandoc$to, c("markdown", "epub", "gfm", "commonmark", "commonmark_x", "markua"))
+}
 
 # apply patches to output as required
 apply_patches <- function(format, includes) {

src/resources/rmd/execute.R

@@ -655,6 +655,16 @@ normalize_options <- function(options) {
                     "attr-message",
                     "attr-warning",
                     "attr-error",
+                    # Paged tables
+                    "max-print",
+                    "sql-max-print",
+                    "paged-print",
+                    "rows-print",
+                    "cols-print",
+                    "cols-min-print",
+                    "pages-print",
+                    "paged-print",
+                    "rownames-print",
                     # Code decoration
                     "tidy-opts",
                     "class-source",

src/resources/rmd/hooks.R

@@ -101,7 +101,8 @@ wrap_asis_output <- function(options, x) {
   # (necessary b/c we no longer do this by overriding kable_html,
   # which is in turn necessary to allow kableExtra to parse
   # the return value of kable_html as valid xml)
-  if (grepl("^<\\w+[ >]", x) && grepl("<\\/\\w+>\\s*$", x)) {
+  if (grepl("^<\\w+[ >]", x) && grepl("<\\/\\w+>\\s*$", x) && 
+      !grepl('^<div class="kable-table">', x)) {
     x <- paste0("`````{=html}\n", x, "\n`````")
   }
 

src/resources/rmd/patch.R

@@ -34,7 +34,7 @@
   postprocess <- function(input, format, output, preserved_chunks) {
 
     # check for html output
-    isHTML <- knitr::is_html_output(format$pandoc$to, c("markdown", "epub"))
+    isHTML <- is_html_output(format)
 
     # bail if we don't have any perserved chunks and aren't doing code linking
     code_link <- isHTML && isTRUE(format$render$`code-link`)