Question

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

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

但这并没有给我所需的输出。我已经为整个软件包启用了markdown支持并安装了roxygen2 6.0.1。降价表是否不支持？我必须使用\tabular{}吗？

Answer 1

请注意，{roxygen}最终会生成R Documentation文件。因此，您始终可以转到Writing R Extensions: Lists and tables并手动以R-packages的本机文档语言编写表。

这是一个最小的例子：

\name{dummy}
\title{Dummy}
\details{
  The example here is:
\tabular{lcc}{
  Tables   \tab  Are           \tab Cool   \cr
  col 3 is \tab  right-aligned \tab $1600  \cr
  col 2 is \tab  centered      \tab  $12   \cr
 }
}

请注意，最新的{roxygen2}版本7.0为markdown语法提供了更多支持。

Answer 2

您需要将@md标签添加到氧气块中

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

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

在roxygen2 R包文档中插入markdown表

2 个答案: