在 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 文件。