roxygen2包支持表格吗？

Question

我想尝试在.Rd文件中使用markdown。 我认为在函数文档的末尾添加@md可以解析markdown。 但是我没有看到出现表格，也没有看到原始文本... 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)
}

- tim

---

它使用commonmark，我在他们的规范中没有看到任何关于表格的内容：http://spec.commonmark.org/0.27/ - Dason

Answer 1

自2019年11月12日起，roxygen2版本7.0.0现已支持使用markdown表格：

Markdown tables are converted to a \tabular{} macro (#290). roxygen2 supports the GFM table syntax which looks like this:

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

你可以在roxygen2说明文档中了解更多相关信息。

- Droplet

---

谢谢！不过请不要忘记先开启 Markdown 支持哦！;-) - Jeremy

Answer 2

似乎此答案已过时，因为这个功能最终被添加了。保留此答案以供历史记录。

---

# 旧答案如下

roxygen2包的文档表示它使用commonmark作为其markdown格式，并且目前为止在commonmark规范中没有关于表格的任何内容。此外，我们可以检查与roxygen2包相关的markdown代码此处和此处，但我们没有发现支持markdown表格的任何内容。

因此，至少在撰写本答案时，似乎你的问题的答案是“不支持”markdown表格。

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

- Dason