为R项目创建文档

Question

我想为我的R代码创建文档。代码是R项目的一部分，但不是包的一部分。有没有一种方法可以使用内置的帮助查看器显示不在包中的代码的文档，而无需创建完整的包？

Answer 1

如果您可以将文档直接保存在代码文件中，则可以在函数上方使用roxygen样式注释。但是，您无法使用典型的?your_function语法轻松查看文档。可能有一种方法可以通过一些黑客来生成文档并将它们放在帮助搜索路径中的某个位置，但这似乎比必要的工作更多。

如果您愿意在函数中包含roxygen2样式文档，那么如果您愿意加载?your_function包，则可以获得良好的docstring语法来查看文档。这是我为你的用例编写的一个软件包 - 在那里你有你想要记录的代码，但是没有花时间或者不关心将它放在一个包中。我建议您阅读the github page for docstring上的自述文件或查看cran page for docstring上提供的小插图。

以下是使用docstring的示例会话：

library(docstring)

square <- function(x){

    #' Square a number
    #'
    #' Calculates the square of the input
    #'
    #' @param x the input to be squared

    return(x^2)
}

# This will display the documentation for square
# just like any other help file would be displayed
?square