Questions tagged «roxygen2»

3
如何使用Roxygen2正确记录S4类插槽?
对于使用roxygen(2)记录类,指定标题和描述/详细信息似乎与函数,方法,数据等相同。但是,插槽和继承是它们自己的动物。在roxygen2中记录S4类的最佳实践(当前或计划中的)是什么? 尽职调查: 我@slot在早期的氧气描述中发现了一个标签。 2008 R-forge邮件列表中的帖子 似乎表明这已经死了,并且不支持@slotroxygen: roxygen2是真的吗?前面提到的帖子建议用户改用LaTeX标记创建自己的逐项列表。例如,扩展"character"该类的新S4类将像这样进行编码和记录: #' The title for my S4 class that extends \code{"character"} class. #' #' Some details about this class and my plans for it in the body. #' #' \describe{ #' \item{myslot1}{A logical keeping track of something.} #' #' \item{myslot2}{An integer specifying something else.} …
306 class  r  s4  slot  roxygen2 

4
如何不使用roxygen2运行示例?
我现在正在编写依赖于Bing Maps Key 的地理编码功能。显然,我宁愿不发表我的作品,而这些例子如果没有一个,就会失败。 如何为用户提供一个示例以使其手动运行,而在运行期间不执行该示例R CMD check?
93 r  roxygen2 

1
在同一包装上使用roxygen2和doxygen?[关闭]
已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗?更新问题,以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我有一个R使用的软件包roxygen2。它在中有一些C代码/src,而我刚开始使用Doxygen。有什么方法可以合并文档或将编译器与roxygen2集成在一起?在哪里放置C代码文档有“最佳实践” 吗? 对roxygen2和doxygen进行谷歌搜索主要导致roxygen与doxygen结果相似。我发现了一些带有Doxyfiles的软件包,但是没有一致的组织。例如,lme4已inst/doc/Doxyfile输出到源目录doxygen外部的文件夹lme4。Matrix的根目录中也有一个Doxyfile(但在以前的版本中是inst。该文档也被导出到package目录之外。 是否有任何理由不将C文档包含在软件包中,或者尽管Doxygen广泛使用,为什么Doxygen在R软件包中却很少使用C? 更新:请参阅相关的roxygen2功能请求

7
fetch(key)中的错误:延迟加载数据库
我不知道发生了什么,一切都很好,但是突然我开始在文档中看到以下错误消息: fetch(key)中的错误:延迟加载数据库'... descopl.rdb'已损坏 我删除了几乎所有代码,然后再次构建,然后发布到Github,但是当我使用另一台笔记本电脑下载软件包时,正在下载和加载该软件包,但是我无法调用任何函数,并且文档指出该错误。 我不知道是什么原因引起的,我正在使用roxygen生成文档。 https://github.com/WilliamKinaan/descopl
74 r  roxygen2 


1
预处理或后处理氧气片段
有什么机制可以转换roxygen看到的注释,最好是在roxygen-> rd转换之前? 例如,假设我有: #' My function. Does stuff with numbers. #' #' This takes an input `x` and does something with it. #' @param x a number. myFunction <- function (x) { } 现在,假设我想在roxygen解析注释之前进行一些注释转换,例如用替换反引号中所有事物实例\code{}。即: preprocess <- function (txt) { gsub('`([^ ]+)`', '\\\\code{\\1}', txt) } # cat(preprocess('Takes an input `x` and …
68 r  roxygen2 
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.