问题标签 [roxygen2]

我是 roxygen 的新手，正在努力了解如何使用它来快速创建新的/自定义包。

即我想知道最低要求是制作一个名为package1using的包devtools，roxygen2/3以便我可以运行命令

分别生成 2000 和 4000 个随机法线

所以让我们举个最简单的例子。

如果我有两个功能fun1和fun2

和

参数是数字，返回值是数字。我很确定这不是 S3 方法，让我们称其为 fun1 和 fun2....我不太确定我还需要提供哪些其他信息。我可以将 fun1 和 fun2 放在单独.R的文件中并添加一点，#'但我不确定是否包含所有与 roxygen 相关的要求，也不确定要包含哪些相关要求以及如何使用它来创建与包一起使用的 rd 文档。我认为命名空间只有名称 fun1 和 fun2？并且包装描述只是一些与我有关的通用信息......以及包装的功能？

任何分步指南都会很高兴收到。

编辑：以下是我开始的距离......

我可以做到以下几点来创建一个 pacakge ......但不能使用 roxygen 来制作文档......

在这里我不确定我是否错过了一堆步骤......

所以在尝试安装时我收到以下错误消息

我创建了一个包并将其推送到github，以便devtools函数install_github()功能易于安装。即 github repo 文件结构使得DESCRIPTION和NAMESPACE位于顶部，而/R和/man文件夹分别包含每个函数的*.R文件和文件。*.Rd

我现在想通过添加新功能对其进行一些升级。

#'我在每个新文件的函数上方都有所有相关的 roxygen 类型 ( ) 文本.R，但找不到roxygen2有助于读取.R文件和编写相关.Rd文件的或其他相关的包函数，希望这不会太难......我想我要问的是，是否可以仅将一个文件添加到另一个现有包中？以便它也更新DESCRIPTION、NAMESPACE 文件。这样我就可以添加、提交并将所有这些更改推送到 github 上的远程仓库？

我已经多次遇到以下问题。

假设您有两个类，classA并classB在以下文件中进行了描述classA.R：

和classB.R

我相信这些文件是按字母顺序阅读的roxygen2，但事实并非如此。如果我尝试构建包，我可能会收到以下错误：

我如何确保roxygenize()知道读取文件的顺序，即应该先读取哪个类定义？

注意：我知道我回答了我自己的问题。那是因为我经常遇到这个问题，并且在查看roxygen2. 因此，作为参考，这是我的发现。

我在同一个家庭中有两个职能。我正在使用 roxygen2 进行记录，可以将它们放在同一个帮助文件中，但不知道如何使文档中的使用字段同时具有这两种功能。

我试过：

这给出了：

我尝试用逗号分隔，它只给出第一个，我尝试了单独的使用标签，它只使用第一个。

如何使用 roxygen 在使用字段中制作两个项目，以便它们位于不同的行（例如?lapply）？

编辑：根据 GeeSee 的问题，整个 .R 文件

可能重复：
如何使用 Roxygen2 正确记录 S4 类插槽

我想构建一个包含S4 classes使用 R Studio 和roxygen2. roxygen2当我将几个函数引入S4 classes我的包时，我已经使用语法记录了我的所有函数。

现在我意识到没有开箱即用的“@slot”功能。所以我想知道我怎样才能让我的所有文档都为其他功能工作，并像这个线程S4 classes中建议的那样手动记录？

或者换句话说，您会推荐哪个工作流程来构建一个包含老式函数和S4 classes?

编辑：您是否建议将 R Studio 构建工具配置为不创建 .Rd 文件。roxygenize手动然后添加信息？这仍然会导致覆盖类的手动生成的 .Rd 文件......

可能重复：
在 Roxygen2 样式文档中转义“@”

如何在 roxygen 文档中使用@，如下所示：

这将在您运行roxygenize而不将@ 放入.Rd 文件时引发警告。

我有一个通用的打印功能，我认为我已经根据通用功能（LINK，诚然我有点难以掌握）和这个问题（LINK）正确设置了它。但是，它仍然会在检查中引发警告。下面是一个模拟函数、打印方法、roxygen 文档和检查中的错误。有关打印功能正在做什么的背景；基本上我希望输出看起来不像是类，但它仍然带有一个类，用于通过后续函数处理该对象。如何使警告消失（并保留打印功能）？

警告：

作为一个简单而具体的例子：

但是，当我尝试构建一个包时，该功能似乎被忽略了，并且没有生成任何文档。

在http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-functions似乎有一个关于二进制中缀函数的单行简介，但我很难解析它的时间，以及它对 Roxygen 文档的影响。

我正在使用\deqn{}{}roxygen2 来记录包中函数的方程。LaTeX（的第一个参数deqn）渲染得很好，因为在 LaTeX 方程中忽略了空格，但是我对 ASCII（的第二个参数deqn）表示有疑问。

问题是我的格式被破坏了（看起来 roxygen 将整个deqn命令放在“单行”上，然后将该行包装在大约 60 列左右）。有没有办法强制 roxygen2 保留 .R 文件中我的 roxygen 命令/注释中的空白格式？

我在文件中有以下代码example.R：

我使用以下 R 代码生成example.Rd文件：

您可以在命令行中使用以下命令生成 example.Rd 文件的文本表示：

上述命令输出的详细信息部分如下所示：

而我希望它看起来像：

我正在尝试在包中使用 S3 方法，并在此处提出问题后认为我理解了如何设置它：使用 Roxygen 构建 R 包时的 S3 方法一致性警告

但现在我得到了我没想到的结果。如果我直接在 R 中运行下面的代码，它会给我预期的结果，但如果我将它编译到一个包中，我不会得到正确的结果（请注意，当它应该只取唯一单词时，单词 the 被计数两次vector a）。我不确定我设置不正确。

.R 文件：

从命令行运行代码（预期行为）：

打包编译后的输出：