Roxygen 真的可以像 Doxygen 对 C++ 那样记录 R 脚本(而不是包)吗?

2023-11-22

Roxygen 的灵感来自 C、C++ 程序员使用的 Doxygen 文档系统。我使用过 Doxygen,我发现只要有 doxygen 注释,记录任何程序都非常容易。它还生成函数和类的调用图。我认为 roxygen 会以同样的方式工作,但是当我搜索 roxygen 帮助时,我只找到了记录 R 包的解决方案。

我在网上查过哈德利·威克姆的roxygen2 帮助但这并没有描述有关 R 脚本文档的任何内容。

我的脚本有时会达到 500-1000 行,并且有几个函数,我总是用注释来记录这些函数。我想生成带有图形可视化图表的 PDF 或 HTML 文档。 Roxygen 是否能够制作调用图和文档独立 R 脚本?


No, roxygen2仅适用于编写包文档。在我看来,您正在寻找报告生成工具。您可以使用knitr为了那个原因。您可以包含代码、注释、文本、MathJax,甚至使用 LaTeX。它还支持目录和参考文献。这绝不是详尽的功能列表。通过一些逻辑限制,您可以生成 pdf 和 html 文档等。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Roxygen 真的可以像 Doxygen 对 C++ 那样记录 R 脚本(而不是包)吗? 的相关文章

随机推荐