问题标签 [roxygen]

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

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

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

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

如果我有两个功能fun1和fun2

和

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

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

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

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

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

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

可能重复：
Roxygen：如何在不同的包中正确记录泛型的 S3 方法？

我尝试基于包尾中定义的 as.mcmc 创建一个方法 as.mcmc.mcmcComposite。这是代码：

它运行良好，但在检查时会产生错误：

我不明白如何纠正这样的错误。感谢您的任何建议

马克·吉伦多

可能重复：
S3 方法的 R-oxygen 文档在检查时产生错误

我的问题S3 方法的 R-oxygen 文档会产生错误，而检查已被关闭，因为它是其他的“完全重复”......很好。但是我在发布我的问题之前当然检查了这些问题，但我没有找到答案！至于这里的人，一定要先关闭一个话题！

当我不使用标签@method 时，我会在检查期间收到警告（上一篇文章）。

如果我使用@method，我会在检查过程中遇到错误（见下文）。

马克·吉伦多

我尝试基于包尾中定义的 as.mcmc 创建一个方法 as.mcmc.mcmcComposite。这是代码：

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

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

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

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

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

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

我想在R文件夹中使用目录结构作为包的源代码。例如，在我R的文件夹中，我有一个algos文件夹，其中包含要导出和记录的功能。但是roxygen2，默认情况下似乎不会通过文件夹的子R文件夹。

我尝试@include在 `R/algos/algo1.r' 的文件中使用如下关键字

但没有成功。有没有一种简单的方法来使用R源代码的子文件夹？

有人可以提供一个如何正确使用模板标签的例子Roxygen2。我试图做最明显的事情（对我来说）：

在我的packageName-package.R文件中：

然后在一个文件中 someFunction.R

我得到错误：

我试图有一个地方来记录常见的重复定义示例等。当这些东西嵌套在我一直在使用的一组函数中时@inheritParms。但是有些东西，如定义和其他描述，在几个地方使用。我已经搜索了高和低的使用@templateand@templateVar并没有找到任何东西。

谢谢。

我教了一门课，让学生使用我写的包。现在课程即将结束，我想为他们提供每个函数的代码，这些代码与函数的文档内联。我可以设置一个全局标志来完成此操作吗？某种代码破解？

短版：我可以使用Normal包中的文档来模拟吗？statsroxygen

长版：我正在开发一个包，并试图通过在一个标题下收集许多具有通用输入/参数的函数来使文档更具可读性，这将是对该组的通用引用。每个功能仍应可供最终用户独立使用。

我以文档为灵感，Normal其中提供了许多与正态分布相关的方法，例如stats::dnorm()。

当我搜索时，?dnorm我发现帮助部分的名称Normal即使Normal看起来不是导出的函数或对象。

我尝试将以下内容放入funs.R：

然后我roxygen2在上面运行。困难在于，R CMD check在这个最小包上运行时，它发现包无法加载为undefined exports: funs. 如果我删除##' @name funs包通过R CMD check但帮助部分的名称sum1而不是funs. 如果我在示例部分下方添加以下内容：

它通过了，我可以看到格式化为我想要的帮助，但我正在导出一个无意义的函数以使名称正确显示。

我尝试查看源帮助文件stats以了解它是如何实现的，但它们的.Rdx格式我不确定如何显示。

另外，在相关的说明中，是 什么样的事情Normal？

更新：

@TylerRinker - 恐怕这是我尝试的第一件事。这会将函数组合到一个.Rd文件中，但相关帮助的名称与第一个函数的名称相同，这是我试图避免的：

@Andrie - 这个解决方案导致完全相同的困难，帮助的名称与第一个函数相同。

也许这只是不可能的......

我想在记录 R 函数的上下文中排版方程中的矩阵。事实上，默认情况下不适amsmath用于 R 文档，并且由于已经打开了相应的数学环境而无法使用。eqnarray\deqn

那么，专业人士是如何做到的呢？通过tabular或一些这样的？