Roxygen 6是否支持表格

时间:2017-03-25 13:48:55

标签: r markdown roxygen2

我想尝试在.Rd文件中使用markdown。 我想我在函数文档的最后得到@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)
}

2 个答案:

答案 0 :(得分:4)

roxygen2软件包的文档表明它使用了commonmark来标记它,而commonmark specs目前还没有表格。最重要的是,我们可以检查与roxygen2包herehere的降价相关的代码,我们找不到任何对降价表的支持。

因此,至少在撰写本答案的时候,似乎你的问题的答案对于降价表来说是“不”。

据说你可以在你的文档中放置表格,但你必须使用LaTeX语法'手工'来做:https://cran.r-project.org/doc/manuals/R-exts.html#Lists-and-tables

答案 1 :(得分:4)

roxygen2 since the 7.0.0 version中现在支持降价表(自2019年11月12日开始在CRAN上):

Markdown表将转换为\ tabular {}宏(#290)。氧气2 支持GFM表语法 看起来像这样:

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

您可以在dedicated roxygen2 vignette中了解更多信息。