在 R 编程或 R markdown 中使用@？

Question

我从另一个程序员那里下载了代码，他们有以下内容：

#' @param gr                a GRanges of regions/DMRs/whatever
#' @param HMM               a GRanges with ChromHMM annotations (name, itemRgb)
#' @param background        a null distribution (universe) whence gr was chosen
#' @param footprint         compute BP footprints instead of number of overlaps?
#' 
#' @return                  a data.frame with overlap frequency and color code
#'
#' @export

我认出 #' 是 knitr spin 的语法。但是我不明白它在这里是如何使用的，或者 @ 符号在做什么。请解释。

Answer 1

#' 部分指定这是通过 R 包 roxygen2 编入适当的 R 文档的部分。 @param 告诉译者将这些东西变成文档的元素。

您发布的示例将创建一个最终将被视为

的帮助文件

functionName(gr, HMM, background, footprint)

在 ?functionName 的用法部分和参数部分下的每个参数的描述等等...请参阅 link @joran 提供（和 Whosebug tag description）关于所有可用标签您可以使用它来指导将此内联文档制作成完整的 .Rd 文件的方式。

在 R 编程或 R markdown 中使用@？

Use of @ in R programming, or R markdown?

r

r-markdown

knitr-spin