在 R 编程中使用 @ 还是 R markdown？答案

【问题标题】：Use of @ in R programming, or R markdown?在 R 编程中使用 @ 还是 R markdown？
【发布时间】：2017-01-30 21:54:20
【问题描述】：

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

#' @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 的语法。但我不明白它是如何在这里使用的，或者@ 符号在做什么。请解释一下。

【问题讨论】：

阅读here 了解包文档并查找 roxygen2 包。
谢谢。我不知道这是一个包裹，因为这是从合作者通过电子邮件发送给我的。我什至不会考虑查看包文档。在我目前的水平上，这些信息对我来说有点难以理解，但我会继续努力。在线查找无效，因为 Google 不理解我输入 @ 符号。

标签： r r-markdown knitr-spin

【解决方案1】：

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

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

functionName(gr, HMM, background, footprint)

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

【讨论】：

所以这意味着我的合作者（谁编写了代码）创建了一个自定义函数，其中包含我将根据请求呈现的文档（即有人在控制台中输入?functionName）？我阅读了很多关于 roxygen2 包和提供的链接的材料。我仍然不完全理解，但这非常有帮助。如果我编写了其他人可能使用的自定义函数，我应该这样做吗？
@GaiusAugustus 您需要制作一个包（制作文档只是该过程的一部分）以使 ?functionName 在 R 中可用。您的合作者所做的可能是目前如何记录您的最佳选择代码。如果您决定构建一个包，小插图也是一个不错的选择。