您如何编写包装文档？ [关闭

Question

我还没有发现一个明智的工作流程来构建包裹和编写文档。

我希望尽可能多地自动生成的过程（和文档）。

这样做的明显方法似乎是使用 package.skeleton 要创建基本的软件包文件，然后编程覆盖 DESCRIPTION 文件和 Rd 文件。这样做的问题是，您然后丢失了自动生成的字段，以确保您已记住记录所有正确的参数。

我想知道如何 你 进行构建包裹和编写文档。是否有任何可使过程更容易的工具？ （（roxygen 看起来它是为这种事情而设计的。有很好的教程吗？还有其他选择吗？）

Answer 1

我在所有项目中都使用roxygen。例如，浏览源 这 Webvis 包裹. 。哈德利还使用roxygen进行文档（例如，请参阅他的 橄榄酸软件包).

据我所知，Roxygen并没有记录在Vigette之外（看看 roxygen首页).

Roxygen很好，因为它会导致识字编程，从某种意义上说，您的文档和代码是并排的。这也使文档过程变得更加容易，因为您立即使用所有内容。我绝对推荐它，并且在这一点上不会开发任何包裹。

也就是说，它并不能自动化文档的自动化，从某种意义上说，某些文档生成工具（例如Javadoc）：Roxygen解释了正确格式的R注释，但并未以任何方式解释R代码。

关于包裹的创建通常： package-skeleton 非常适合初学者。创建了一些软件包后，您可能会发现它更容易，只是手工创建所有目录，名称空间等。尤其是如果您要遵循其他一些实践，例如使用roxygen，编写小插图或其他语言中的源代码，包括演示目录，使用roxygen。

最后，我在Eclipse（statet）中管理包裹；许多IDE都具有帮助管理软件包结构的“项目”视图，因此您可能还需要使用更高级的编辑器。

Answer 2

关于Roxygen资源，此后还出现了更多的资源，还出现了一些报价 我自己的笔记:

通常，当我Google roxygen或roxygen2时，我很难找到文档。这是一些关键资源的汇编：

• 哈德利·威克姆（Hadley Wickham） Roxygen 2的核心特征简介2

• 有 Roxygen 2的Cran网站上列出了几个小插图2

• Rstudio有笔记 运行roxygen

• roxygen2软件包源代码在github上