在 R 包目录结构中在哪里包含文本注释？

【问题标题】：Where to include text notes in R package directory structure?在 R 包目录结构中在哪里包含文本注释？
【发布时间】：2020-01-06 18:52:44
【问题描述】：

我编写了一个R 包，目前具有以下目录结构：

.git 
.Rproj.user 
docs 
inst 
man 
Meta 
R 
tests 
vignettes

我将包代码保存在 GitHub 存储库中。我想以 TXT 文件的形式添加一个注释，其中将包含一些与包相关的信息（主包算法的伪代码）。我想将它添加到包中，以便可以从包的 GitHub 存储库中访问它。

在文件中添加它的最佳位置是什么，以便包检查不会抛出有一些冗余文件挂起的消息？

【问题讨论】：

标签： r directory package

【解决方案1】：

Writing R Extensions 中的package subdirectories section 是规范参考（尽管相当密集和技术性很强）。

你可以把它放在inst/doc中，例如：我认为inst/中的任何东西都没有被特别检查。

或者，如果您希望它在 GitHub 上但不包含在包材料中，请将文件名放入 .Rbuildignore（您的 .git、.Rproj.user 等应该已经在那里；我不确定你为什么有一个Meta 目录，它通常在已安装 包中？）。（我建议您将它放在inst/doc 中，以便安装了该软件包的最终用户可以在需要时找到它。）

【讨论】：

这太完美了，谢谢！我浏览了Writing R Extensions，但遗憾的是错过了。干杯！