Package: checklist 0.5.3

Thierry Onkelinx

checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

An opinionated set of rules for R packages and R source code projects.

Authors:Thierry Onkelinx [aut, cre], Els Lommelen [ctb], Hans Van Calster [ctb], Research Institute for Nature and Forest [cph, fnd, pbl]

checklist_0.5.3.tar.gz
checklist_0.5.3.zip(r-4.7)checklist_0.5.3.zip(r-4.6)checklist_0.5.3.zip(r-4.5)
checklist_0.5.3.tgz(r-4.6-any)checklist_0.5.3.tgz(r-4.5-any)
checklist_0.5.3.tar.gz(r-4.7-any)checklist_0.5.3.tar.gz(r-4.6-any)
checklist_0.5.3.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
checklist/json (API)
NEWS

# Install 'checklist' in R:

install.packages('checklist', repos = c('https://inbo.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/inbo/checklist/issues

Pkgdown/docs site:https://inbo.github.io

On CRAN:

checklist continuous-integration continuous-testing quality-assurance

7.77 score 21 stars 3 packages 26 scripts 61 exports 110 dependencies

Last updated from:e61eb5df82. Checks:7 ERROR, 2 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	ERROR	263
source / vignettes	OK	264
linux-release-x86_64	ERROR	196
macos-release-arm64	ERROR	138
macos-oldrel-arm64	ERROR	118
windows-devel	ERROR	161
windows-release	ERROR	131
windows-oldrel	ERROR	141
wasm-release	OK	144

Exports:add_badges ask_rightsholder_funder ask_yes_no author2df bookdown_zenodo c_sort check_codemeta check_cran check_description check_documentation check_environment check_filename check_folder check_license check_lintr check_package check_project check_source check_spelling checklist citation_meta clean_git create_draft_pr create_hexsticker create_package create_project custom_dictionary default_organisation execshell get_branches_tags get_default_org_list inbo_org_list install_pak is_repository is_workdir_clean menu_first new_branch new_org_list org_item org_list organisation prepare_ghpages read_checklist read_organisation set_license set_tag setup_package setup_project setup_source spelling store_authors tidy_desc update_citation use_author validate_email validate_orcid write_checklist write_citation_cff write_organisation write_zenodo_json yesno

Dependencies:askpass assertthat backports base64enc brew brio bslib cachem callr cli clipr codemeta codemetar codetools commonmark cpp11 crayon credentials crul curl desc devtools diffobj digest downlit ellipsis evaluate fansi fastmap fontawesome fs gert gh gitcreds glue highr htmltools htmlwidgets httpcode httpuv httr httr2 hunspell ini jquerylib jsonlite knitr later lifecycle lintr magrittr memoise mime miniUI openssl otel pak pillar pingr pkgbuild pkgconfig pkgdown pkgload praise prettyunits processx profvis promises ps purrr R6 ragg rappdirs rcmdcheck Rcpp remotes rex rlang rmarkdown roxygen2 rprojroot rstudioapi rversions sass sessioninfo shiny sourcetools stringi sys systemfonts testthat textshaping tibble tinytex triebeard urlchecker urltools usethis utf8 vctrs waldo whisker withr xfun xml2 xmlparsedata xopen xtable yaml zip

Coding style rules

Rendered fromcoding_style.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2025-11-25
Started: 2025-11-25

File paths in code

Rendered frompath.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2023-06-07
Started: 2023-06-07

Naming conventions for folders and files

Rendered fromfile_name.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2025-11-25
Started: 2025-11-25

Organisations

Rendered fromorganisation.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2026-02-18
Started: 2024-05-30

Philosophy of the checklist package

Rendered fromphilosophy.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2025-11-25
Started: 2021-04-23

Recommended folder structure

Rendered fromfolder.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2023-03-08
Started: 2023-03-08

Setting up checklist for a package

Rendered fromgetting_started.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2025-11-25
Started: 2021-04-23

Setting up checklist for a project

Rendered fromgetting_started_project.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2026-01-12
Started: 2023-03-08

Setting up the integration between GitHub, Zenodo and ORCID

Rendered fromzenodo.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2026-02-18
Started: 2022-01-19

Spell checking with checklist

Rendered fromspelling.Rmdusingknitr::rmarkdownon May 19 2026.

Last update: 2023-03-08
Started: 2022-09-14

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
add badges to a README	add_badges
Ask for rights holder or funder	ask_rightsholder_funder
Function to ask a simple yes no question Provides a simple wrapper around 'utils::askYesNo()'. This function is used to ask questions in an interactive way. It repeats the question until a valid answer is given.	ask_yes_no
Convert person object in a data.frame.	author2df
Render a 'bookdown' and upload to Zenodo	bookdown_zenodo
Sort using the C locale	c_sort
Check the package metadata	check_codemeta
Run all the package checks required by CRAN	check_cran
Check the 'DESCRIPTION' file	check_description
Check the documentation	check_documentation
Make sure that the required environment variables are set on GitHub	check_environment
Check the style of file and folder names	check_filename
Check the folder structure	check_folder
Check the license of a package	check_license
Check the packages for linters	check_lintr
Run the complete set of standardised tests on a package	check_package
Run the required quality checks on a project	check_project
Standardised test for an R source repository	check_source
Spell check a package or project	check_spelling
The checklist R6 class	checklist
The 'citation_meta' R6 class	citation_meta
Clean the git repository	clean_git
Create a draft pull request	create_draft_pr
Make hexagonal logo for package	create_hexsticker
Create an R package according to INBO requirements	create_package
Initialise a new R project	create_project
Add words to custom dictionaries	custom_dictionary
Write default organisation settings	default_organisation
Pass command lines to a shell	execshell
Get branches and tags of a GitHub repository	get_branches_tags
Get the default organization list	get_default_org_list
The INBO organisation list	inbo_org_list
Install extra packages defined in 'checklist.yml'	install_pak
Determine if a directory is in a git repository	is_repository
Check if the current working directory of a repo is clean	is_workdir_clean
Improved version of menu()	menu_first
Create a new branch after cleaning the repo	new_branch
Interactively create a new organisation list	new_org_list
The 'org_item' R6 class	org_item
The 'org_list' R6 class	org_list
The organisation R6 class	organisation
Prepare a 'gh-pages' branch with a place holder page	prepare_ghpages
Display a 'checklist_spelling' summary	print.checklist_spelling
Read the check list file from a package	read_checklist
Read the organisation file	read_organisation
Set the proper license	set_license
Set a New Tag	set_tag
Add or update the checklist infrastructure to an existing package	setup_package
Set-up 'checklist' on an existing R project	setup_project
Add or update the checklist infrastructure to a repository with source files.	setup_source
The spelling R6 class	spelling
Store author details for later usage	store_authors
Make your DESCRIPTION tidy	tidy_desc
Create or update the citation files	update_citation
Which author to use	use_author
Check if a vector contains valid email	validate_email
Validate the structure of an ORCID id	validate_orcid
Write a check list with allowed issues in the source code	write_checklist
Write a 'CITATION.cff' file	write_citation_cff
Write organisation settings	write_organisation
Write a '.zenodo.json' file	write_zenodo_json
A function that asks a yes or no question to the user	yesno