roxygen2是一个类似Doxygen的源文档系统,用于Rd,collation和NAMESPACE。它的主要用途是在函数定义中记录R函数。
我在R中有一个人R6对象类,其中包含Person $ new()的随附的create_person()函数。因此,两个函数(create_person()和person $ new()/initialize)具有精确的
Prevent square brackets being turned into \link in conversion from ROxygen to Rd
I am copying a function from the checkmate package which contains the following bit of ROxygen documentation: #'\ item {strict:} {执行\ dquote {unique}之类的检查,并为...
在roxygen2中,可以使用标签@inheritParams继承另一个函数的全套参数。但是否也可以仅继承其中的某个子集? (不包括
在 R 中创建包时 if (newversion != oldversion) 出错
我正在创建一个新的 R 包,当我尝试清理并安装 RStudio 上的按钮时,我在控制台中收到以下错误消息: > 库(MY_R_PACKAGE) 如果 (
我很清楚当代码直接在 roxygen 注释中时如何让 roxygen 不运行示例。 但是,某些示例可能有点冗长,或者您希望在以下情况下编译示例...
假设我有两个函数 f 和 g,并且在我的 roxygen2 文档中,我希望 g 的 @examples 扩展 f 的示例。 如果我手写它们,它看起来像这样: #' 加一
我有一个包含许多使用相同参数的函数的包,并且这些参数应该具有相同的文档。我当然可以使用@inheritParams,但是没有一个函数可以
我不知道发生了什么事,一切都工作得很好,但突然我开始在文档中出现此错误消息: fetch(key) 中出错:延迟加载数据库 '......descopl.rdb' 我...
“box::”包的新增内容。如何将magrittr管道运算符集成到模块中?
我最近接触到了“box”包,并认为将我的函数合并到单个 r 脚本中真是太棒了,我可以使用它将它们导入到其他脚本中 盒子...
我正在向 CRAN 提交 R 包,但在运行 devtools::check(remote = TRUE, manual = TRUE) 时遇到以下注意事项: 检查手册的 HTML 版本...注意 ...
我正在遵循 roxygen2 文档,并尝试制作软件包。 我运行了他们提供的示例,但还使其可导出。 #' 将两个数字相加 #' #'...
我想使用 S3 调度来实现内部功能。但是,当我创建类似的东西时 我的乐趣 <- function(x) { UseMethod("myfun") } myfun.someclass <- function(x) { print(x) }
如何在 roxygen2 @examples 中运行文档功能?
我有很多类似的功能,只需要在文档中更改一两个单词。为了限制重复,我使用文档中的函数。 这在 roxygen2 中适用于@
在其他包中使用 R 包中的函数:何时以及如何使用 importFrom、:: 和导入
我已经阅读了 R 包书中的部分,但我仍然有点困惑。我想用例如我自己的小包中 jsonlite-package 中的 fromJSON 函数。 我有点不确定该做什么...
我渴望学习如何将数据示例合并为写在函数上方的注释,例如: ##' @例子 ##' ## 设置工作目录... ##' ## 将数据加载到 R 会话中: ##'数据<-
我有一个带有静态方法的 R6 类(类似于 C# 或 Java 静态方法)。代码工作正常。我想用 Roxygen2 记录静态方法,但找不到如何执行此操作。 #'测试课...
如何使用 Roxygen2 通过单个帮助页面正确记录同一仿制药的两个 S4 方法?
我正在使用 Roxygen2 构建 R 包作为文档。我想为我的程序的两个类中的每一个实现相同的 S4 方法。我不知道如何正确设置文档......
如何使用 @importFrom 以便它适用于整个 R 包?
自动化数据分析工作流程 我的 packagename 文件夹中的 packagename.R 文件中有以下代码。 我知道我将定期使用其他包中的某些功能,所以我想
某些软件包(例如 base)在给出命令 help("base") 或 ?base 时会显示描述该软件包的帮助页面。 当 roxygen2 i...