roxygen2 - IT屋-程序员软件开发技术分享社区

含Roxgen2的参考套餐小品

因此，我想在函数的roxygen2注释中引用我的包小插图之一，但我很难理解如何做到这一点。更一般地，我们如何引用/inst/doc中的文档？例如，我想在myFunc的roxygen2评论中引用/inst/doc/mypdf.pdf。那会是什么样子？这有可能吗？推荐答案我只是告诉人们运行打开Vignette的代码： #' For more details see the h ..

发布时间：2022-08-02 22:24:00 r knitr r-markdown roxygen2 其他开发

我正在创建一个包含一些功能的包.只有一个辅助功能需要plotly. 但是，当我使用 devtools 安装时，我得到一个注释 unused arguments in layout(yaxis = ay,... 然后我阅读了 Hadley 关于 imports 与 depends 的文章.使用 import 不会'不删除注释，但在 NAMESPACE 文件中添加 plotly 和 depend ..

发布时间：2022-01-21 15:33:02 r plotly devtools roxygen2 其他开发

使用 roxygen2 在单个文档对象中记录多个数据集

我正在寻找一个等效于 @describeIn 的工具，它允许我为多个 R 数据对象创建一个文档对象. 我曾希望是这样的: #' 树的距离#'#' 这些数据集包含集合之间的距离#' 的 10-tip、11-tip 和 12-tip 树.#'#' @name treeDistances#' @keywords 数据集“treeDistances10"“treeDistances11"“tree ..

发布时间：2022-01-21 13:03:01 r dataset documentation documentation-generation roxygen2 其他开发

开发一套依赖 R 包的最佳实践

我开始研究一系列 R 包，所有这些包都共享大量的公共代码，这些代码都存放在自己的包中，我们称之为 myPackageUtilities.所以我有几个包 myPackage1、myPackage2 等... 所有这些包都依赖于 myPackageUtilities 中的每个方法.有关真实示例，请参阅 statnet on CRAN.这个想法是未来的开发人员可能会创建 myPackageN ..

发布时间：2022-01-15 23:14:23 r dependencies packages roxygen2 其他开发

一个 .Rd 文件中的多个功能

短版:我可以使用 roxygen 来模拟 stats 包中 Normal 的文档吗? 长版:我正在开发一个包，并试图通过在一个标题下收集许多具有通用输入/参数的函数来使文档更具可读性，这将是一个通用参考到组.每个功能仍应可供最终用户独立使用. 我以 Normal 的文档为灵感，该文档提供了许多与正态分布相关的方法，例如stats::dnorm(). 当我搜索 ?dnorm 时，我 ..

发布时间：2022-01-13 17:23:33 r documentation package roxygen roxygen2 其他开发

在开发 R 包中包含数据示例

我很想学习如何将数据示例合并为写在函数上方的注释，例如: ##' @examples##' ## 设置工作目录...##' ## 将数据加载到 R 会话中:##' 数据 ..

发布时间：2022-01-13 16:50:21 r package roxygen2 其他开发

使用 roxygen2 导入两个同名函数

我是 CRAN 包的维护者，在加载时收到以下消息: * 检查是否可以安装包‘qdap’ ... [10s/10s] 警告发现以下重要警告:警告:加载“NLP"时替换以前的导入“注释"警告:加载“缩放"时替换以前的导入“重新缩放" 因为我使用 plotrix 和 scales 包以及 NLP 和 ggplot 包.它们具有共同的功能 rescale 和 annotate.这会导致最新的 CRAN ..

发布时间：2022-01-13 16:37:46 r package roxygen2 其他开发

为自定义 S3 对象编写“as.data.frame"方法

在许多变体中，类似的问题已被问过多次......但我没有找到明确的建议: “将 S3 方法导出为函数" 我使用 roxygen2 编写了一个自定义 S3 类，将其命名为 'my_item'.这是构造函数: my_item ..

发布时间：2021-09-17 19:20:15 r vectorization roxygen2 其他开发

在 Sublime Text 3 中，如何更改注释字符?

我喜欢自动评论功能 Ctrl +/，但我希望能够任意更改它使用的字符.我读过很多类似的问题，比如这个，但这并不是一个通用的解决方案. 如何让评论字符使用不同的东西?具体用例是我正在编写 R 代码并使用 Roxygen2 作为文档.这使用 #' 作为注释字符，而不仅仅是 #.所以我想将 sublime 设置为使用 #' 因为按原样，我不能将它用于 Roxygen2 注释. 关于 Subl ..

发布时间：2021-08-31 20:15:05 sublimetext3 roxygen2 其他开发

roxygen2 不创建 .Rd 文档

我无法使用 RStudio 和 Roxygen2 为我的包生成 .Rd 文档文件.首先，让我提一下，我经历过这里发布的类似问题，并且已经完成了以下操作: Roxygen2 块在文件开头用 #' 启动已配置的构建工具>使用 Roxygen 选中生成文档> 配置 > 选中“使用 roxygen 生成"和“运行时自动 roxygenize"下的所有字段确保“man"文件夹中没有 . ..

发布时间：2021-07-10 21:17:08 r rstudio roxygen2 其他开发

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

我正在努力处理 R6 类及其方法的文档.我的目标是在 RStudio 中获得方法的自动完成.目前，我只得到了方法的名称，但没有得到我通常使用 roxygen2 记录带有参数等的函数的帮助信息. 目前，这是我的班级: #' @importFrom R6 R6ClassMQParameters 如果你有兴趣测试这个类，这里有一个可重现的小例子: df 我不知道如何记录参数，因为参 ..

发布时间：2021-07-10 21:14:05 r rstudio roxygen2 r6 其他开发

用 roxygen2 覆盖 NAMESPACE 和 Rd

我用 RStudio 创建了一个新包.在“配置构建工具"中，我选中了“使用 Roxygen 生成文档". 我第一次单击“构建"窗格中的“文档"时，一切正常: ==>roxygen2::roxygenize('.', roclets=c('rd', 'collate', 'namespace'))第一次使用roxygen2.自动升级...写hello.Rd书写命名空间文件已完成我知道 ..

发布时间：2021-07-10 21:13:47 r rstudio roxygen2 其他开发

对于包含 S4 类的包，推荐的包构建工作流程是什么?

可能的重复: 如何使用 Roxygen2 正确记录 S4 类插槽我想使用 R Studio 和 roxygen2 构建一个包含 S4 类的包.当我在包中引入几个 S4 类时，我已经使用 roxygen2 语法记录了我的所有函数. 现在我意识到没有现成的“@slot"功能.所以我想知道如何让我的所有文档都适用于其他函数，并像这个线程? 或者换句话说，您会推荐哪种工作流程来 ..

发布时间：2021-07-10 21:13:15 r rstudio s4 roxygen2 其他开发

RStudio 可以为函数自动生成 roxygen 模板吗?

RStudio 是否支持任何自动化的 roxygen 模板创建? 在 Emacs-ESS 中，C-x C-o 将为函数生成一个 roxygen 模板.例如，它会自动转换: foo 进入这个: ##' .. \description{} 的内容(无空行)..##'##' .. \details{} 的内容 ..##' @标题##' @param x##' @param y##' @返回 ..

发布时间：2021-07-10 21:08:42 r roxygen rstudio roxygen2 其他开发

用于插入 roxygen #' 注释开始的键盘快捷键

这个问题可能被过度回答了，但我找不到.基本上我使用 RStudio 和键盘快捷键 cmd + shift + c 插入注释.是否有其他组合可以直接插入 roxygen 标签 #' ?或者当我按下 cmd + shift + c 时修改 RStudio 以告诉它添加 ' 的方法? 解决方案您可以使用 RStudio 插件，您将需要一个相当新版本的 RStudio.我刚刚创建了一个 RStu ..

发布时间：2021-07-10 21:07:46 r rstudio roxygen2 其他开发

创建 R 包时出错:dyn.load(file, DLLpath = DLLpath, ...) 中的错误

我正在创建一个名为 CVOC 的 R 包.它包含 C++ 代码并使用来自 C 库 gmp 的高精度算法. 要通过以下步骤创建包: 1) 使用 Rcpp::Rcpp.package.skeleton 创建包骨架. 2) 将需要的文件，例如DESCRIPTION、NAMESPACE、Makevars等复制到正确的文件夹中 3) 使用 roxygen2::roxygenise() ..

发布时间：2021-07-03 18:48:17 r rcpp gmp roxygen2 其他开发

使用 roxygen2 构建 R 包时出错

我有 2 个文件，Rfile.R 和 Cppfile.cpp. Cppfile.cpp 中的内容: #include 使用命名空间 Rcpp；//[[Rcpp::export]]int CPPF(int k){return ++k;} Rfile.R 中的内容: RF 我想基于这两个文件构建一个 R 包.我使用最新版本的 Rstudio 和 Roxygen2. 我尝试了 3 种 ..

发布时间：2021-07-03 18:40:33 r rcpp roxygen2 其他开发

在 R 包中重命名和隐藏导出的 Rcpp 函数

编写R包，我有一个R函数调用特定的Rcpp函数.Rcpp 函数仅用作辅助函数，我不想为其创建 .Rd 文件.到目前为止，我的解决方案是在命名空间文件中导出这两个函数，这会导致警告在我运行 check 命令后立即为 Rcpp 函数创建一个 .Rd 文件.如果我删除命名空间文件中的辅助函数，我将摆脱这个警告，现在导致 R 函数无法再找到它的问题. 有没有办法解决这个问题.这意味着要使 Rcpp ..

发布时间：2021-07-03 18:38:56 r rcpp r-package roxygen2 其他开发

Roxygen2 - 如何正确记录 S3 方法

我已经阅读了 Roxygen2 PDF 以及这个网站，我我对@method @S3method @export 之间的区别以及如何使用它们正确记录 S3 方法之间的区别感到迷茫.我整理了以下示例进行讨论: 1. 我如何正确记录这些? 2. 我如何模拟 ?print 和其他通用函数的文档，这些函数显示所有特定于类的实现的用例(即 ?print 显示“因子"、“表"、“函数"的用法的方式 ..

发布时间：2021-06-30 19:58:20 r roxygen roxygen2 其他开发

为不在软件包中的R6类创建Rd文档文件

我正在尝试创建一些脚本的文档，其中包含一些R6类.作为示例，我使用名为"Person"的R6Class.从这里开始: https://www.tidyverse.org/blog/2019/11/roxygen2-7-0-0/ 我正在使用此功能 https://stackoverflow.com/a/59073260/12166017 创建文档而没有需要创建一个包.是否也可以将其用于R6Cl ..

发布时间：2021-05-09 20:02:17 r function roxygen2 r6 其他开发

roxygen2相关内容