r - Use of @ in R programming, or R markdown?

Question

I've downloaded code from another programmer, and they have the following:

#' @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

I recognize the #' as syntax from knitr spin. But I don't understand how it's being used here or what the @ symbol is doing. Please explain.

Answer 1

该#'部分指定这是要通过 R package 编织到适当的 R 文档中的部分roxygen2。他们@param告诉翻译人员将这些东西变成文档的元素。

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

functionName(gr, HMM, background, footprint)

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