r语言 - roxygen2 封装是否支持表

Question

我想尝试在 中使用 markdown。RD 文件。我想我得到的@md在函数的文档末尾使其解析降价。但是没有看到这个表格出现，也没有出现原始文本......roxygen支持表吗？

#' makes bar
#' @description
#' prints 2 x
#' @details see this table
#' 
#' |a |b |c |
#' |--|--|--|
#' |1 |3 |4 |
#'
#' @param x how much foo
#' @return - 
#' @export
#' @family tmp
#' @examples
#' foo(2)
#' @md
foo <- function(x) {
    print(2 * x)
}

Answer 1

自 7.0.0 版本以来，roxygen2 现在支持降价表(自 2019-11-12 起在 CRAN 上(：

Markdown 表将转换为 \tabular{} 宏 (#290(。 roxygen2 支持 GFM 表语法 看起来像这样：

| foo | bar | 
| --- | --- | 
| baz | bim | 

您可以在专用的 roxygen2 小插图中阅读更多相关信息。

Answer 2

这个答案似乎已经过时了，因为最终添加了此功能。出于历史目的保留答案。

---

# 旧答案如下

roxygen2软件包的文档说它使用commonmark作为它的markdown，到目前为止，commonmark规范中没有任何关于表格的内容。 最重要的是，我们可以在这里和这里检查与 roxygen2 包的 markdown 相关的代码，我们找不到对 markdown 表的任何支持。

因此，至少在撰写此答案时，您的问题的答案似乎对降价表是"否"。

话虽如此，您可以将表格放在文档中，但您必须使用 LaTeX 语法"手动"完成：https://cran.r-project.org/doc/manuals/R-exts.html#Lists-and-tables