inbobmk/checklist

checklist工具

概述和主要用途

checklist旨在为R包和R代码提供详细且严格的检查，确保代码符合指定的规范和质量标准。该工具最初为比利时自然与森林研究所（INBO）设计，默认集成INBO的特定要求，同时支持自定义组织配置，满足不同团队的代码质量控制需求。

核心功能和特性

• 多维度检查：提供R包和代码的全面检查，涵盖文档完整性、代码风格、文件结构、CRAN兼容性等
• 组织自定义：支持配置GitHub组织、联系信息、版权持有者等组织特定参数，覆盖非INBO用户需求
• 灵活初始化：提供包和项目两种初始化模式，适配不同开发场景
• 选择性检查：支持运行单个检查或全套检查，并可保存检查结果更新配置
• 依赖管理：兼容CRAN和INBO universe等安装源，确保依赖正确安装

使用场景和适用范围

• R包开发者需确保包符合组织规范和质量标准
• 研究团队需要统一代码检查流程和规范
• 学术机构或企业需要标准化R代码质量控制流程
• 协作开发项目中需维持一致的代码风格和文档标准

详细使用方法和配置说明

安装方法

从INBO universe安装

r
# 启用INBO universe
options(
  repos = c(
    inbo = "https://inbo.r-universe.dev", CRAN = "https://cloud.r-project.org"
  )
)
# 安装包
install.packages("checklist", dependencies = TRUE)

从GitHub安装

r
# 安装remotes包（若未安装）
# install.packages("remotes")
remotes::install_github("inbo/checklist", dependencies = TRUE)

设置默认组织

非INBO用户需自定义组织配置，通过organisation$new()创建组织对象并设为默认：

r
library(checklist)
org <- organisation$new(
  github = "组织GitHub名称",          # GitHub组织账号
  community = "社区名称",             # 社区标识
  email = "组织联系邮箱",             # 官方联系邮箱
  rightsholder = "版权持有者名称",    # 代码版权持有者
  funder = "资助机构名称",            # 资助机构
  organisation = list(
    "域名" = list(
      affiliation = c(                # 多语言机构名称
        en = "英文机构名称",
        nl = "荷兰文机构名称"  # 可根据需求增减语言
      ),
      orcid = TRUE/FALSE              # 是否要求ORCID标识
    ) 
  )
)
# 设置为默认组织
default_organisation(org = org)

详细配置说明参见：vignette("organisation", package = "checklist")

在R包上使用checklist

初始化检查环境

r
# 在包根目录执行
create_package()

运行检查

r
# 运行全套检查
check_package()

# 运行单个检查
check_cran()         # CRAN标准兼容性检查
check_description()  # 包描述文件检查
check_documentation()# 文档完整性检查
check_lintr()        # 代码风格检查
check_filename()     # 文件名规范检查
check_folder()       # 文件夹结构检查
update_citation()    # 引用信息更新检查

保存检查结果

r
# 运行检查并保存结果
x <- check_package()
# 更新配置文件以允许特定警告/提示
write_checklist(x)

在R项目上使用checklist

初始化检查环境

r
# 在项目根目录执行
library(checklist)
create_project()

运行检查

r
# 运行全套检查
check_project()

# 运行单个检查
check_lintr()        # 代码风格检查
check_filename()     # 文件名规范检查
check_folder()       # 文件夹结构检查
update_citation()    # 引用信息更新检查

保存检查结果

r
# 运行检查并保存结果
x <- check_project()
# 更新配置文件以允许特定警告/提示
write_checklist(x)

组织配置详情

查看完整组织配置选项：

r
# 查看组织配置帮助文档
?organisation$new