在 roxygen2 R 包文档中插入 markdown table

Question

我正在编写一个 R 包，我想在 R 帮助文件中包含一个 table，例如在 @details 部分。我尝试直接包含降价代码：

#' | Tables        | Are           | Cool  |
#' | ------------- |:-------------:| -----:|
#' | col 3 is      | right-aligned | 00 |
#' | col 2 is      | centered      |    |

但这并没有给我想要的输出。我已经为整个包启用了 markdown 支持并安装了 roxygen2 6.0.1。不支持降价tables吗？我必须使用 \tabular{} 吗？

Answer 1

请注意，{roxygen} 最后会生成 R 文档文件。因此，您始终可以转到 Writing R Extensions: Lists and tables 并用 R 包的本机文档语言手动编写 table。

这是一个最小的例子：

\name{dummy}
\title{Dummy}
\details{
  The example here is:
\tabular{lcc}{
  Tables   \tab  Are           \tab Cool   \cr
  col 3 is \tab  right-aligned \tab 00  \cr
  col 2 is \tab  centered      \tab     \cr
 }
}

请注意，最新的 {roxygen2} 7.0 版本提供了对 markdown 语法的更多支持。

Answer 2

您需要将 @md 标签添加到您的 roxygen 区块

#' @details
#' The table is: 
#'
#' | Tables        | Are           | Cool  |
#' | ------------- |:-------------:| -----:|
#' | col 3 is      | right-aligned | 00 |
#' | col 2 is      | centered      |    |
#' 
#' @md

或将 Roxygen: list(markdown = TRUE) 添加到您的 DESCRIPTION 文件。

在 roxygen2 R 包文档中插入 markdown table

Insert markdown table in roxygen2 R package documentation

markdown

r

roxygen2