如何为我用 R 编写的函数创建帮助？

Question

我想为我自己的功能创建帮助页面。所以如果我定义一个函数：例如：

myfunct <- function(x,y,z){...}

如果我输入，?myfunct我会得到我给出的参数规格。

有没有办法做到这一点？

Answer 1

您应该创建一个包。我建议使用 Roxygen 包作为文档。

http://roxygen.org/ http://cran.r-project.org/doc/manuals/R-exts.html

除了 ESS 之外，rstudio http://www.rstudio.com/ide/和 statet http://www.walware.de/goto/statet 都支持它。