我创作了一个R
包,目前具有以下目录结构:
.git
.Rproj.user
docs
inst
man
Meta
R
tests
vignettes
我将包代码保存在 GitHub 存储库中。我想以 TXT 文件的形式添加一个注释,其中包含一些与包相关的信息(主包算法的伪代码(。我想将其添加到包中,以便可以从包的 GitHub 存储库访问它。
在文件中添加它的最佳位置是什么,以便包检查不会抛出一些冗余文件挂起的消息?
编写 R 扩展的包子目录部分是规范引用(尽管相当密集和技术性(。
你可以把它放在inst/doc
,例如:我认为inst/
中的任何内容都没有经过专门检查。
或者,如果您希望它在 GitHub 上但不包含在包材料中,请将文件名放在.Rbuildignore
中(您的.git
、.Rproj.user
等应该已经存在;我不确定为什么你有一个Meta
目录,它通常在已安装的软件包中?(我建议你把它放在inst/doc
,以便安装该软件包的最终用户可以根据需要使用它。