在 R 编程或 R 降价中使用@？

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 文档的roxygen2 。 @param告诉翻译者把这些东西变成文档的元素。

您发布的示例将创建一个帮助文件，该文件最终将被视为

functionName(gr, HMM, background, footprint)

在?functionName Usage 部分和 Arguments 部分下每个参数的描述下...请参阅@joran 提供的链接（和stackoverflow 标签描述），了解所有可用标签，您可以使用这些标签来指导如何将此内联文档制作成完整的 .Rd 文件。