带有 knitr 的 Rnw 文档中的 SQL 代码

Question

我在.Rmd 文档中使用了以下sql 代码。但是，我想在.Rnw 文档中使用相同的 SQL 代码。

```{r label = setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, max.print = NA)
```

```{r, echo=FALSE, results='hide'}
library(DBI)
db <- dbConnect(RSQLite::SQLite(), dbname = "survey.db")
dbListTables(db)
```


```{sql, label = Q1, connection=db, tab.cap = "Table Caption"}
SELECT * 
  FROM Person;
```

希望获得代码格式化和输出打印功能。

Answer 1

将 RMarkdown 移植到 RNW 需要一些调整：

• 当然，块分隔符需要调整：```{r, echo=FALSE} 的 RNW 等效项是 <<echo=FALSE>>=，而 RNW 块以 @ 结尾。 （见minimal RNW example。）
• 重要的是，虽然 RMarkdown 文档中的块总是指定一个引擎，但 RNW 中的引擎隐式为 R，除非设置了选项 engine。所以```{r} 变成了简单的<<>>=，但是```{sql} 的等价物是<<engine="sql">>=。
• RMarkdown 在嵌入 SQL 块时包含一些非常有用的魔法，请参阅knitr Language Engines: SQL on rmarkdown.rstudio.com。默认情况下，结果呈现为漂亮的表格，并且只打印前 10 个结果。在 RNW 中，我们需要自己解决这个问题。

为了在 RMarkdown 中嵌入 SQL，请注意 SQL 连接必须通过 connection 选项传递给 SQL 块。选项output.var 可用于指定将分配查询结果的对象的名称。

一个简单的解决方案（参见previous revision）只需使用output.var 将SQL 结果分配给一个对象，比如res，然后添加另一个可以很好地打印res 的R 块，例如使用xtable。但是，使用hooks 有一种更优雅的方法：

_{该示例使用来自sqlitetutorial.net 的SQLite sample database。在运行代码之前将其解压缩到您的工作目录。}

\documentclass{article}

\begin{document}
\thispagestyle{empty}
<<include=FALSE>>=
library(knitr)
library(DBI)

knit_hooks$set(formatSQL = function(before, options, envir) {
  if (!before && opts_current$get("engine") == "sql") {
    sqlData <- get(x = opts_current$get("output.var"))
    max.print <- min(nrow(sqlData), opts_current$get("max.print"))
    myxtable <- do.call(xtable::xtable, c(list(x = sqlData[1:max.print, ]), opts_current$get("xtable.args")))
    capture.output(myoutput <-do.call(xtable::print.xtable, c(list(x = myxtable, file = "test.txt"), opts_current$get("print.xtable.args"))))
    return(asis_output(paste(
      "\\end{kframe}", 
      myoutput,
      "\\begin{kframe}")))
  }
})

opts_chunk$set(formatSQL = TRUE)
opts_chunk$set(output.var = "formatSQL_result")
opts_chunk$set(max.print = getOption("max.print"))

@

<<echo=FALSE, results="hide">>=
db <- dbConnect(RSQLite::SQLite(), dbname = "chinook.db")
@

<<engine = "sql", connection=db, max.print = 8, xtable.args=list(caption = "My favorite artists?", label="tab:artist"), print.xtable.args=list(comment=FALSE, caption.placement="top")>>=
SELECT *  FROM artists;
@

\end{document}

添加了一个新的块挂钩formatSQL。 （只要对应的块选项不是NULL，块挂钩就会运行。）在带有engine="sql" 的块之后，它将SQL 结果读入sqlData。然后，它使用xtable 打印结果的第一行max.print。

默认情况下，块钩子formatSQL被激活（即它被全局设置为TRUE）并且SQL结果存储在formatSQL_result中。块选项max.print 控制要打印的行数（将其设置为Inf 以打印所有行，总是）。

xtable 制作的表格是高度可定制的。块选项xtable.args 被传递给xtable，print.xtable.args 被传递给print.xtable。在示例中，这些选项用于设置标题、标签和禁止 xtable 的默认注释。

在生成的 PDF 下方。请注意，RNW requires 中非 R 代码的语法高亮显示安装 highlight 并将目录添加到路径 (Windows)。