问题标签 [roxygen]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
1422 浏览

documentation - R 文档与 Roxygen?

我发现 R 文档很重要,但创建/维护也很耗时。有没有人使用过 Roxygen,如果有,它对维护 R 包有帮助吗?我过去使用过 Doxygen,但这些项目没有 R 包所需的man结构。

你可以在这里找到小插图

0 投票
3 回答
12825 浏览

r - 如何使用 roxygen 记录数据集?

是否可以在 roxygen 进程中将 .R 文件包含在我的包的数据目录中?

我在数据目录中放了几个 .R 文件。当它们以 data() 为源时,它们会读入原始数据文件并执行一些转换。

0 投票
3 回答
1047 浏览

r - Roxygen 可以忽略非用户功能吗?

我刚开始玩这个roxygen包,到目前为止我对结果非常满意。但是我想知道,有没有办法指定roxygen它应该忽略某些用户不可访问的功能?

具体来说,我宁愿不.Rd弹出文件,因为我.onLoad()在我的包中使用了钩子。这个函数已经记录在base包中,所以我没有理由重新记录它。

0 投票
2 回答
1246 浏览

r - 使用 RUnit 或 roxygen 编写的优秀示例 R 包有哪些?

我正在编写一个将被其他人使用的R包,所以我正在努力把它做好!我想将roxygen用于文档,将 RUnit用于单元测试,但我以前没有使用过它们。

存在哪些软件包(在 CRAN 上或其他地方)可以很好地使用这些工具中的任何一个?

0 投票
2 回答
3163 浏览

r - 如何在 roxygen 识字编程中转义 %?

我的函数的一个参数的默认值包含一个“%”。这似乎是 roxygen 的一个问题,它会在尝试构建乳胶文档时产生很多警告并且 R CMD 检查失败。

我怎样才能使这个功能(及其文档)工作?使用 %% 或 \% 而不是 % 没有帮助。

0 投票
3 回答
571 浏览

r - 有没有办法自动更新 R 包中的文档?

几个月前,我使用“package.skeleton()”生成 .Rd 帮助文件。我编辑了这些文件,还更改了功能,删除了一些功能,添加了其他功能。是否有自动更新 Rd 文件的功能?

更新

一个不错的包刚刚发布,叫做Rd2roxygen,作者 Yihui Xie 在他的博客上描述了它。

顾名思义,这个包允许将当前包含在 .Rd 中的文档追溯插入到 .R 文件中。对于学习 roxygen 和将当前正在开发的包转换为 R 包来说,这听起来像是一种很有前途的方法。呜呼。谢谢一辉!

根据 Joshua 和 Yihui 的回答,答案似乎是: roxygen 允许根据源 .R 代码的更改自动更新 Rd 文件等,如果我目前不使用 roxygen,Rd2roxygen 可以帮助我迁移。

0 投票
2 回答
665 浏览

r - Roxygen、包构建和使用。Rd2=TRUE

我有一个简单的 shell 脚本,用于构建我的 Roxygen 文档、构建包、检查,然后在我的机器上安装新构建的包。这很简单:

但是我遇到了 Roxygen 拾取我的 .onLoad() 函数的问题,如前所述 StackOverflow。解决方案是将 use.Rd2=TRUE 选项与 roxygenize 一起使用。好吧,我想从命令提示符构建,所以我更改了这一行

到以下行,该行通过标准输入将 roxygenize 行推到 R :

似乎只是花花公子。但是感觉有点绕。有没有更简单和/或更优雅的方式?

0 投票
4 回答
1282 浏览

r - R CMD 氧气无法识别

我刚刚试用了 Roxygen 包。在 R 中,我可以运行 Roxygen Vignette 中的示例。但在命令行中,R CMD roxygen不被识别为有效命令。当我运行时R CMD --help,我可以看到所有INSTALL, check, ...sweave..., config...命令项,但看不到 roxygen。谁能帮我解决这个问题?是否需要其他安装步骤install.packages("roxygen")?我使用带有 R 2.12.0 和工作 Rtools 环境的 Windows 32。谢谢。

0 投票
3 回答
3194 浏览

r - 如何使用 roxygen 正确记录 S4“[”和“[<-”方法?

0 投票
3 回答
2659 浏览

r - Roxygen 的好参考?

除了这里出色的 SO 答案以及 Roxygen手册小插图之外,是否有任何关于使用 Roxygen 的特别全面的指南?