roxygen2 仅用于记录 R 包还是用于 R 项目？

Question

我对 "roxygen2" 包有疑问：

我看过很多将它用于包文档的教程（例如 Hadley Wickham 的主要 "object documentation" 页面）

那么，如果我有不是包的 R 代码，比如 R 项目怎么办？ 你能用 roxygen2 记录 R 项目吗？

我仍然能够运行 package.skeleton(name='RoxygenSkeleton', code_files = "Roxygen.R", force=TRUE) 创建基本包结构的函数，并创建了 .Rd 文件。但我希望 HTML 或 PDF 格式的输出很好...

Answer 1

As explained elsewhere，从 roxygen2 6.0 开始，以下工作用于解析包外记录的 R 源文件。

source_env = roxygen2::env_file(sourcefile)
rd_blocks = roxygen2::parse_file(sourcefile, source_env)
help_topics = roxygen2::roclet_process(roxygen2::rd_roclet(), rd_blocks, source_env, dirname(sourcefile))
rd_code = lapply(help_topics, format)

roxygen2 仅用于记录 R 包还是用于 R 项目？

Is roxygen2 only for documenting R packages or also for R projects?

r

documentation-generation

roxygen2