预览开发R文档

Question

我正在使用RStudio IDE中的devtools和roxygen2编写我的第一个R包。我遇到的问题与预览.Rd文件有关，当我“循环”.R文件时。我正在使用devtools::document()来获取.Rd文件，但当我尝试通过编写以下任何内容来预览帮助页面时：

help("FunctionName")
?FunctionName

控制台显示消息“使用...的开发文档”，但帮助窗口中有一个空白区域。使用devtools:load_all()会导致同样的问题。也许这与devtools在环境中加载包的方式有关，但是文档“Writing R Extensions”（预计不会被查阅以使用roxygen），也不是书“ R包“由Hadley Wickham提供了一个可行的解决方案。

Answer 1

在Rstudio的项目选项下，有一个带有roxygen项目的生成文档-进行检查。

然后单击配置... 并选中类似的框：

现在，每当您按Ctrl + Shift + B组合键，您的doc文件就会重新生成，您可以通过单击函数名并单击F1或在控制台中键入以下任一行来浏览它们：

?my_function
help(my_function)