roxygen2 相关问题

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

无法在包文档中的@format标签下添加列表

我正在尝试将数据集文档添加到我的包中的函数中,并遵循 roxygen2 提供的有关记录其他对象的格式。但是更新后我不断收到错误

回答 1 投票 0

R 包文档:链接到整个包,而不是函数

我想在我正在开发的一些函数的文档中引用另一个包(整个包,而不仅仅是其中的一个函数)。我正在使用 Roxygen2 注释来记录我的包功能。 我

回答 2 投票 0

如何在 R 包中的函数之前加载内部存储的数据?

我目前正在为我的合作者编写一个 R 包,其中包含特定于项目的数据清理功能,使用 devtools 和 roxygen2 并遵循 RStudio 建议的格式。其中有很多

回答 1 投票 0

Shift+Cmd+D 是复制粘贴前一行而不是记录 R 包

Shift+Cmd+D 被列为 R 中记录包的标准键盘快捷键,但最近 Shift+Cmd+D 一直在复制粘贴上一行代码而不是生成包文档...

回答 1 投票 0

尽管存在默认方法,但 S3 通用“没有适用的方法”

这很棘手,因为这个问题只发生在包的上下文中——在全局命名空间中定义时,一切都按预期工作。 我定义了一个名为 coerce_na_range() 的 S3 泛型,

回答 1 投票 0

使用省略号(...)时如何继承参数的自动完成功能

我有一个函数 foo 和一些文档,使用 roxygen2。 #' @param a 描述 a #' @param b 描述 b 富<- function(a, b, c){ cat(a, b, c) } I have written a wrapper ...

回答 1 投票 0

使用 roxygen 固定参数描述的顺序

我正在尝试整合一组函数的文档。然而,这些函数并不具有完全相似的参数集。相反,它们是相关的,因为它们在同一系统上运行......

回答 1 投票 0

如何删除自动创建的 pkgname-package.R 中重复的包别名?

我对折旧的徽章使用了生命周期,这要求我使用 usethis::use_package_doc (我相信 - 这可能不是这个函数,但我认为它是)。这产生了一个脚本 myPkgName-

回答 1 投票 0

roxygen 文档不会在 `\usage{}` 中生成 `\method{}{}` 调用

我将 R 包从 .Rd 转换为 roxygen 文档,并收到警告 从 R CMD 检查我无法理解和解决。 存在此问题的一个文件是ridge.R 以及由

回答 0 投票 0

在包开发的 R 示例中重复代码片段

所以我正在开发一个 R 包,我注意到我在几个函数示例中不断重复相同的代码片段。 它是这样的:设置一些变量,规范化包中包含的数据......

回答 0 投票 0

@exportS3Method 必须与函数一起使用

我在 arrow.R 中有一个函数 #' @rdname 箭头 #' @return 一个箭头数组。 #' @exportS3Method 箭头::as_arrow_array #' 作为_arrow_array.HArray <- function(x) { "whatever" } When I do:

回答 0 投票 0

R 文档:@family 标签不起作用

我正在写一个 R 包,我想在函数文档之间包含交叉引用。 在此处的文档之后,有一个专门讨论此问题的部分: 交叉

回答 1 投票 0

使用产生错误的 Roxygen2 记录和添加数据集:“数据”不是从“命名空间:包”导出的对象

我有一个包,它使用全局变量为所有函数提供错误代码。数据文件 errorCodes.rda 位于 R\data 中。根据 Roxygen2 的文档,我需要 ...

回答 0 投票 0

如何在 `roxygen2` 中的@params 之间包含非参数文本?

我想在参数定义之间的参数块中放置副标题。在常规 Rd 中,这看起来像下面这样: 参数{ \item{x}{x的描述} 任何参数外的文本 \

回答 0 投票 0

忽略脚本与roxygen2

我正在编写一个在服务器上做一些工作的软件包。我有一个更新表的脚本,但我的意图是不手动和不频繁地运行它。它并不是一个需要在服务器上运行的函数。

回答 1 投票 0

为什么我在R中使用写函数时得到问号?

我有以下代码,我创建了一个API的文档和功能。当我使用写代码时,我遇到了问题。代码的第三行最后加入了......。

回答 1 投票 0

用deqn和roxygen记录方程。

我正在用 roxygen2 来记录一个包中函数的方程式。LaTeX (deqn的第1个参数) 渲染得很好,因为LaTeX方程中忽略了空白,但我有一个 ...

回答 2 投票 19

在donttest的情况下,Travis的CI运行实例

很有可能,我错过了一些直接的东西。但是,似乎在Travis CI上的等价检查过程中,R检查正确地忽略了用donttest包装的例子。这里的例子是...

回答 1 投票 1

R包DESCRIPTION不显示在?

在RStudio roxygen2中构建一个R包。在Roxygen configure里有这些设置(如下图)。然而,当我构建之后,我无法看到漂亮的文档,当我尝试:> ?PackageName它只是 ...

回答 1 投票 -1

如何定义引用另一个包中的S4类的包示例

我正在构建一个软件包,以扩展另一个软件包crmPack的功能。 crmPack使用S4类。我正在使用roxygen记录我的新包装。运行devtools时出现错误:...

回答 1 投票 0

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