roxygen2 项目使用文档

roxygen2 项目使用文档

roxygen2 Generate R package documentation from inline R comments 项目地址: https://gitcode.com/gh_mirrors/ro/roxygen2

1. 项目目录结构及介绍

roxygen2/
├── devcontainer/
├── github/
├── inst/
├── man/
├── pkgdown/
│   └── favicon/
├── revdep/
├── src/
├── tests/
├── vignettes/
├── Rbuildignore
├── covrignore
├── gitattributes
├── gitignore
├── DESCRIPTION
├── LICENSE
├── LICENSE.md
├── NAMESPACE
├── NEWS.md
├── README.md
├── _pkgdown.yml
├── codecov.yml
├── cran-comments.md
└── roxygen.Rproj

• devcontainer/: 包含开发容器配置文件。
• github/: 包含GitHub相关配置文件。
• inst/: 包含安装时需要复制的文件。
• man/: 包含生成的Rd文档文件。
• pkgdown/favicon/: 包含pkgdown网站的favicon文件。
• revdep/: 包含反向依赖检查相关文件。
• src/: 包含C++源代码文件。
• tests/: 包含测试代码文件。
• vignettes/: 包含项目教程文件。
• Rbuildignore: 指定在构建包时忽略的文件。
• covrignore: 指定在代码覆盖率检查时忽略的文件。
• gitattributes: 指定Git属性。
• gitignore: 指定Git忽略的文件。
• DESCRIPTION: 包的描述文件。
• LICENSE: 许可证文件。
• LICENSE.md: 许可证文件的Markdown版本。
• NAMESPACE: 包的命名空间文件。
• NEWS.md: 项目更新日志。
• README.md: 项目介绍文件。
• _pkgdown.yml: pkgdown网站配置文件。
• codecov.yml: 代码覆盖率配置文件。
• cran-comments.md: CRAN提交时的注释文件。
• roxygen.Rproj: RStudio项目文件。

2. 项目启动文件介绍

项目启动文件为 roxygen.Rproj，这是一个RStudio项目文件。通过打开这个文件，可以在RStudio中启动项目，并自动加载项目环境。

3. 项目的配置文件介绍

• DESCRIPTION: 描述包的基本信息，如包名、版本、作者、依赖等。
• NAMESPACE: 定义包的命名空间，控制哪些函数和对象是导出的，哪些是导入的。
• _pkgdown.yml: 配置pkgdown网站的生成选项，如网站结构、样式等。
• codecov.yml: 配置代码覆盖率检查的选项，如忽略的文件、覆盖率阈值等。
• cran-comments.md: 提交到CRAN时的注释文件，记录包的更新和注意事项。

通过这些配置文件，可以定制化项目的构建、文档生成、代码覆盖率检查等流程。

roxygen2 Generate R package documentation from inline R comments 项目地址: https://gitcode.com/gh_mirrors/ro/roxygen2