r - 在 roxygen2 R 包文档中插入 Markdown 表

Question

我正在编写一个 R 包，我想在 R 帮助文件中包含一个表格，例如在 @details部分。我尝试直接包含 Markdown 代码:

#' | Tables        | Are           | Cool  |
#' | ------------- |:-------------:| -----:|
#' | col 3 is      | right-aligned | $1600 |
#' | col 2 is      | centered      |   $12 |

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

Answer 1

您需要添加 @md标记到您的 roxygen 块

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

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