[英]Does the roxygen2 package support tables?
我想尝试在 .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)
}
从 7.0.0 版本开始,现在支持roxygen2 中的降价表(自 2019-11-12 起在 CRAN 上):
Markdown 表被转换为 \\tabular{} 宏(#290)。 roxygen2 支持 GFM 表语法,如下所示:
| foo | bar | | --- | --- | | baz | bim |
您可以在 专用的 roxygen2 小插图中阅读更多相关信息。
由于最终添加了此功能,因此此答案似乎已过时。 出于历史目的保留答案。
roxygen2 包的文档说它使用 commonmark 作为它的降价,并且目前在commonmark 规范中没有关于表格的任何内容。 最重要的是,我们可以在这里和这里检查与 roxygen2 包的降价相关的代码,我们没有找到任何对降价表的支持。
因此,至少在撰写此答案时,您的问题的答案似乎对降价表来说是“否”。
话虽如此,您可以将表格放入文档中,但您必须使用 LaTeX 语法“手动”完成: https : //cran.r-project.org/doc/manuals/R-exts.html#Lists-和-表
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.