roxygen2 相关问题

roxygen2是一个类似Doxygen的源文档系统,用于Rd,collat​​ion和NAMESPACE。它的主要用途是在函数定义中记录R函数。

导入软件包的S3方法而不导入其功能

我正在开发的程序包中具有以下依赖关系链:我的程序包使用程序包A(simmer)中定义的类(轨迹)。它还对该类使用了S3方法(plot.trajectory),...

回答 2 投票 4

将第二个软件包的S3方法导入第一个软件包中定义的类,而不导入第二个软件包

我正在开发的程序包中具有以下依赖关系链:我的程序包使用程序包A(simmer)中定义的类(轨迹)。它还对该类使用了S3方法(plot.trajectory),...

回答 2 投票 4

R对象文档:包装文档为第一项

我有一个R软件包,我想在创建的PDF手册中作为第一个项目显示有关该软件包的一般信息。我使用roxygen2(7.0.2版)创建文档,然后使用...

回答 1 投票 2

在每个.Rd文件中自动调用宏或插入模板

我正在使用roxygen记录R软件包。我在程序包的“ man / macros”子目录中有一个宏文件myMacro.Rd。该文件指定\ myMacro宏。 (宏会插入 ...

回答 1 投票 0

知道软件包是在哪个R版本下创建的?

我们如何准确确定R软件包的版本是哪个R?示例在这里的RSelenium包的Description文件中,我们看到Depends:R(> = 3.0.0),但这似乎不......>

回答 1 投票 0

S3通用/方法一致性-如何根据所选类型进行调度?

我正在尝试构建一个通用函数,该函数根据所选算法的类型调度到其他函数。在下面的示例中,算法的类型仅由“ ...

回答 1 投票 2

devtools :: document()未创建data.R手动文件

在我的R包中,我已经以roxygen2格式记录了一些函数和数据,但是运行devtools :: document()只会为我已记录的函数生成.Rd文件,而不会生成数据。在这里...

回答 1 投票 0


在roxygen2 R软件包文档中插入减价表

我正在写一个R包,我想在R帮助文件中包含一个表,例如在@details部分中。我尝试直接包含降价代码:桌子是|酷#'| ----...

回答 1 投票 6

使用roxygen2生成命名空间:一个小例子或模板

使用roxygen2生成名称空间对我来说是全新的。已经多次询问并回答了一些相关问题,以及http://r-pkgs.had.co.nz/namespace.html。我仍然找到它...

回答 1 投票 0

如何使用或转义@符号,以便可以在R软件包文档中使用它?

@是R文档中的特殊字符,那么如何在文档中使用文字@?我试过使用单,双,三和四反斜杠。但是没有运气。示例#'@ ...

回答 1 投票 1

roxygen2 6.0.0现在是否在最后一行中要求“ @export”?

在更新到roxygen2版本6.0.0之前,似乎使用@export标记支持该软件包,而不是在软件包中函数标头的底部。例如:#'标题#'@param foo#'...

回答 1 投票 24

r脚本中的文档功能

我在脚本中有一些功能,我想使用#roxygen2来记录这些功能,但是在线资源已经指向在软件包中记录功能。我不想...

回答 1 投票 0

在RStudio中记录R包中的R6类和方法

我正在努力学习R6类及其方法的文档。我的目标是在RStudio中获取方法的自动完成。目前,我只得到方法的名称,但没有帮助......

回答 2 投票 14

为什么`devtools :: document()`在函数定义为空的`setMethod`上跳转?

假设我正在使用RStudio中的devtools构建一个R包。假设我有这个R源文件,其代码如下:#'@ param object一个对象#'@ param data数字向量或data.frame#'@ ...

回答 1 投票 2

使用RStudio自动记录Shiny应用程序的功能

我正在开发一个Shiny应用程序,并且达到了比我预期更多功能的点。我计划用testthat开始自动化测试,我很想用...记录我的功能...

回答 1 投票 2

r包文档中的等式不起作用

我正在使用roxygen2作为我的包描述,我希望在我的文档中有数学方程式。例如,我想像公式一样写n_ {u}。当我在@details中写\ eqn {n_ {u}}时......

回答 2 投票 0

不要通过roxygen2在构建R包中显示功能帮助文档

我使用devtools来构建R包,并且有些功能并非设计为最终用户可见。但是,由于这些函数涉及通过.Call调用C代码,所以我有......

回答 3 投票 13

roxygen警告::缺少姓名

所以我正在尝试使用roxygen2来记录我的代码。不幸的是,我的主管认为在全球环境中有这么多功能的人很杂乱。所以我被告知要把它们隐藏在子...

回答 3 投票 4

尝试使用devtools :: install()安装本地R包时“超出API速率限制”

包开发初学者在这里!我第一次尝试将一些代码转换为本地R包。我使用usethis :: create_package()创建了一个包,使用devtools ::添加了文档...

回答 1 投票 6

© www.soinside.com 2019 - 2024. All rights reserved.