The Checklist Package

The goal of checklist is to provide an elaborate and strict set of checks for R packages and R code.

Installation

You can install the package from the INBO universe via

# Enable the INBO universe
options(
  repos = c(
    inbo = "https://inbo.r-universe.dev", CRAN = "https://cloud.r-project.org"
  )
)
# Install the packages
install.packages("checklist")

If that doesn’t work, you can install the version from GitHub with:

# install.packages("remotes")
remotes::install_github("inbo/checklist")

Examples

You can run the full list of checks

library(checklist)
check_package() # for packages
check_source() # for a project with R and Rmd files

Or run the individual checks

check_cran()
check_description()
check_documentation()
check_lintr()
check_filename()

Create a checklist.yml to allow some of warnings or notes.

write_checklist()

Start a package from scratch with everything set-up

create_package()