为CRAN上的R包文档创建HTML索引的方法咨询
给CRAN R包添加RStudio帮助视图HTML索引的实现方法
先规范包的文档结构
每个对外暴露的函数都得有对应的R文档(.Rd文件)。用roxygen2最省心,给每个函数加@export标签,再补好标题、描述这些必要内容,生成文档时会自动产出标准的.Rd文件。构建文档与索引
运行devtools::document()更新所有文档,这一步R会自动在包根目录生成INDEX文件——里面存着所有导出函数的列表和对应帮助页的链接。RStudio的Help面板会读取这个文件,你在查看包帮助时就能看到函数索引列表了。想要更美观的HTML索引?用pkgdown
如果需要带搜索、分类功能的网页版索引,就用pkgdown工具:- 在包目录下执行
pkgdown::init_site()初始化配置文件 - 运行
pkgdown::build_site()生成完整的包文档网站,其中会自动生成函数索引页面 - 之后在RStudio里用
help(package = "你的包名", help_type = "html")打开HTML版帮助,就能快速定位目标函数
- 在包目录下执行
提交CRAN前的检查
用devtools::check()过一遍包的完整性,确保文档符合CRAN规范,避免因文档问题被打回。另外pkgdown生成的网站无需提交给CRAN,只要包本身的文档结构合规,用户安装后RStudio就能自动显示函数索引。
内容的提问来源于stack exchange,提问作者piechevall
相关产品推荐
相关产品推荐

