我应该如何处理 R 包中的“助手"功能?
背景 我编写了一个 R 包，现在一位合作者(刚接触 R 的 CS 毕业生)正在编辑和重构代码.在此过程中，他将我的功能划分为更小、更通用的功能. 他所做的事情是有道理的，但是当我开始使用 package.skeleton() 时，每个函数都有一个文件.现在，他添加了主要功能所依赖的功能，但这可能在功能本身之外的用途有限. 他建议所有功能都放在一个文件中，但我反对，因为当我们处理不
..
roxygen相关内容
一个 .Rd 文件中的多个功能
短版:我可以使用 roxygen 来模拟 stats 包中 Normal 的文档吗? 长版:我正在开发一个包，并试图通过在一个标题下收集许多具有通用输入/参数的函数来使文档更具可读性，这将是一个通用参考到组.每个功能仍应可供最终用户独立使用. 我以 Normal 的文档为灵感，该文档提供了许多与正态分布相关的方法，例如stats::dnorm(). 当我搜索 ?dnorm 时，我
..
在编写自己的 R 包时，我似乎无法正确导入其他包
好的，第一次尝试编写 R 包，我被卡住了.这是我创建包的方式: package.skeleton("pkg",code_files=some.filenames)roxygenize(“okg") 我正在使用 roxygen2 并且在我的“pkg-package.R"文件中有以下导入: @import data.table zoo lubridate 然后从终端运行: R CMD 构建包
..
RStudio 可以为函数自动生成 roxygen 模板吗?
RStudio 是否支持任何自动化的 roxygen 模板创建? 在 Emacs-ESS 中，C-x C-o 将为函数生成一个 roxygen 模板.例如，它会自动转换: foo 进入这个: ##' .. \description{} 的内容(无空行)..##'##' .. \details{} 的内容 ..##' @标题##' @param x##' @param y##' @返回
..
尝试在使用 roxygenise() 时应用非函数，找不到错误源
我正在尝试使用 roxygen2 将文档添加到我的任意 Rcpp 包中，但我不断收到相同的错误消息 >roxygen2::roxygenise("anRpackage")第一次使用roxygen2.自动升级....f(.x[[i]], ...) 中的错误:尝试应用非函数另外: 警告信息:roxygen2 需要编码:UTF-8 我的源代码中没有“.f(.x[[i]])"，而且我不认识“.f"形式
..
Roxygen2 - 如何正确记录 S3 方法
我已经阅读了 Roxygen2 PDF 以及这个 网站，我我对@method @S3method @export 之间的区别以及如何使用它们正确记录 S3 方法之间的区别感到迷茫.我整理了以下示例进行讨论: 1. 我如何正确记录这些? 2. 我如何模拟 ?print 和其他通用函数的文档，这些函数显示所有特定于类的实现的用例(即 ?print 显示“因子"、“表"、“函数"的用法的方式
..
情节的新方法-如何导出?
我正在制作一个包装，在其中我想定义一种新的绘图方法.我正在使用roxygen的源文件.这个问题似乎非常类似于:如何使用Roxygen从不同的软件包中正确记录了通用的S3方法?和 Roxygen2-如何正确记录S3方法但我仍然无法使其正常工作. 引起我麻烦的相关部分是: #'通用绘图方法#'#'@param x \点#'@param ... \点#' @出口绘图
..
在Roxygen中进行记录时：如何在@details中列出项目清单？
例如，在@details部分中，将逐项列表添加到roxygen2的适当语法是什么？我可以创建乳胶列表环境吗？ 似乎只是简单地忽略了换行符，即 ＃'@详细描述参数输入的文本 ＃' ＃'参数1：填充 ＃' ＃'参数2：填充 谢谢！ 解决方案 这里是遵循问题表达方式的roxygen2示例。 ##' ##' @details详细描述参数输入的文本。 ##
..
就像Doxygen在C ++中一样，Roxygen真的可以记录R脚本（不是软件包）吗？
Roxygen受到C，C ++程序员使用的Doxygen文档系统的启发。我已经使用过Doxygen，只要您有doxygen注释，我发现记录任何程序真的很容易。它还会为函数和类生成调用图。我以为roxygen会以相同的方式工作，但是当我搜索roxygen帮助时，我只找到记录R包的解决方案。 我已经检查了Hadley Wickham的在线 roxygen2 help ，但这并没有描述有关R脚本文
..
是否可以在testthat或run_examples（）中使用R包数据？
我正在使用devtools，testthat和roxygen2开发R软件包。我在数据文件夹中有几个数据集（foo.txt和bar.csv）。 我的文件结构如下： / mypackage /数据 * foo.txt，bar.csv /插入 /测试 * run-all.R，test_1.R /人 / R 我很确定'foo'和'bar'已正确记录：
..
devtools roxygen软件包创建和rd文档
我是roxygen的新手，正在努力寻找如何使用它来快速创建新的/自定义程序包。 即我想知道最低要求是使用 devtools ，制作一个名为 package1 的软件包roxygen2 / 3 ，以便我可以运行命令 require（package1） fun1 （20） fun2（20） 分别生成2000和4000个随机法线。 所以让我们举一个最简单的例子
..
使用Roxygen的内联包装概述文档
我想这是我在文档中经常忽略的一件简单的事情，但是我似乎无法弄清楚如何使程序包级文档在R中工作.我不是在指功能或特定于类的东西.文档，但键入时获得的文档，例如，?stats. 我遵循了我在网上找到的一般说明，创建了一个保存为.R的概要文档文件. .R文件是使用程序包脚本复制的，但是帮助文档并未编入.Rd文件(除非我添加了也以程序包命名的函数定义). 我尝试过的例子: #'_PACK
..
Roxygen2-如何@export引用类生成器?
例如，假设我有一个名为Test的以下程序包，并且我想导出类A: # In /R/Test.R: #' @docType package #' @import methods #' @exportClass A A libr
..
有没有一种方法可以自动更新R软件包中的文档?
几个月前，我使用'package.skeleton()'生成了.Rd帮助文件.我已经编辑了这些文件，还更改了功能，删除了一些功能，添加了其他功能.有自动更新Rd文件的功能吗? 更新 刚刚发布了一个不错的软件包，名为 Rd2roxygen ，由作者Yihui Xie在他的博客上. 顾名思义，此软件包允许将.Rd中当前包含的文档追溯插入.R文件中.听起来像是一种有前途的方法，既可以学
..
自动记录数据集
我现在正在一个项目上，在这里我一直在慢慢积累来自许多不同来源的许多不同变量.作为一个有点聪明的人，我为每个主"original_data"目录下的目录创建了一个不同的子目录，并包括一个带有URL的.txt文件以及其他从中获取数据的描述符.这些.txt文件不够聪明，没有任何结构. 现在，我面临着编译方法部分的任务，该部分记录了所有不同的数据源.我愿意仔细研究并为数据添加结构，但是随后我将需要找
..
在for循环中生成markdown注释
我正在尝试使用knitr基于具有for循环的R脚本生成HTML报告.我想从for循环中的注释生成markdown注释，但不确定是否可行. 这是一个简单的示例，这在test.R中: for (i in 1:5) { ## This is a heading for `i` #' This is a comment for `i` print(i) }
..
在编写自己的R包时，我似乎无法正确导入其他包
好吧，第一次尝试写一个R包，我被卡住了。以下是我创建包的方法： package.skeleton（“pkg”，code_files = some.filenames） roxygenize （“okg”） 我正在使用roxygen2并在我的“pkg-package中使用以下导入.R“文件： @import data.table zoo lubridate
..
使用roxygen2的R包中的源子目录
我想在 R 文件夹中使用一个目录结构作为软件包的源代码。例如，在我的 R 文件夹中，我有一个 algos 文件夹，其中包含要导出和记录的功能。但是，默认情况下， roxygen2 似乎没有通过 R 文件夹的子文件夹。 我试图在`R / algos / algo1.r上的文件中使用 @include 关键字如下' ＃'@include algos / algo1.r 但
..
好的参考Roxygen？
除了优秀的SO答案之外，此处，以及Roxygen 手册和小插曲，有没有使用Roxygen的特别彻底的指南？ 解决方案 我正在开发一个指南（但仍然不完整）。 添加了更全面的小插曲集到包，并在版本4.0.0的CRAN上提供。
..
多个功能在一个.Rd文件中
简短版本：可以在包 stats 中使用正常 roxygen ？ 长版本：我在打包，正在尝试通过在一个标题下收集一些具有常用输入/参数的函数，使文档更易读，这将是该组的通用引用。每个功能仍然可以独立用于最终用户。 我以正常的文档为灵感，它提供了许多与正态分布有关的方法。 统计:: dnorm（）。 当我搜索？dnorm 我发现帮助部分的名称是 / code>即使正常似乎不是导出的函
..