Package: checklist 0.6.1

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.6.1.tar.gz
checklist_0.6.1.zip(r-4.7)checklist_0.6.1.zip(r-4.6)checklist_0.6.1.zip(r-4.5)
checklist_0.6.1.tgz(r-4.6-any)checklist_0.6.1.tgz(r-4.5-any)
checklist_0.6.1.tar.gz(r-4.7-any)checklist_0.6.1.tar.gz(r-4.6-any)
checklist_0.6.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
checklist/json (API)

# 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:

Conda:

checklistcontinuous-integrationcontinuous-testingquality-assurance

7.67 score 21 stars 2 packages 25 scripts 39 exports 103 dependencies

Last updated from:5e93a3b6ae. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK266
source / vignettesOK201
linux-release-x86_64OK241
macos-release-arm64OK192
macos-oldrel-arm64OK183
windows-develOK191
windows-releaseOK203
windows-oldrelOK193
wasm-releaseOK164

Exports:add_agentsadd_issue_templatesask_rightsholder_funderc_sortcheck_crancheck_descriptioncheck_documentationcheck_environmentcheck_filenamecheck_foldercheck_licensecheck_lintrcheck_packagecheck_projectcheck_sourcecheck_spellingchecklistclean_gitcreate_hexstickercreate_packagecreate_projectcustom_dictionaryexecshellinstall_pakis_repositoryis_workdir_cleannew_branchprepare_ghpagesread_checklistset_licenseset_tagsetup_packagesetup_projectsetup_sourcespellingtidy_descupdate_citationwrite_checklistyesno

Dependencies:askpassassertthatbackportsbase64encbrewbriobslibcachemcallrcitemeclicliprcodetoolscommonmarkcpp11crayoncredentialscurlcyclocompdescdevtoolsdiffobjdigestdownlitellipsisevaluatefansifastmapfontawesomefsgertgitcredsgluehighrhtmltoolshtmlwidgetshttpuvhttr2hunspellinijquerylibjsonliteknitrlaterlifecyclelintrmagrittrmemoisemimeminiUIopensslotelpakpillarpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRcppremotesrexrlangrmarkdownroxygen2rprojrootrstudioapirversionssasssessioninfoshinysourcetoolsstringisyssystemfontstestthattextshapingtibbletinytexurlcheckerusethisutf8vctrswaldowhiskerwithrxfunxml2xmlparsedataxopenxtableyamlzip

Coding style rules
Coding style | checklist default | Rules for coding style | Static code analysis checks | Using a different coding style | References
Rendered fromcoding_style.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2025-11-25

Naming conventions for folders and files
Rules for folder names | Rules for file names | Rules for graphical file names
Rendered fromfile_name.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2025-11-25

Philosophy of the checklist package
Available checks | Extensive report on checks | Errors, warnings and notes | Changes | Session info | Making code findable and citable | Integration with Zenodo and ORCID | Bundling your code in a package | Benefits of using a package for your analysis
Rendered fromphilosophy.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2021-04-23

Setting at the organisation level
Coding style | pkgdown style | License files
Rendered fromorganisation.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2024-05-30

Setting up checklist for a package
Starting an R package from scratch | Prepare online setup | Local setup | Finalise online setup in GitHub | Get it working with an existing package or update the checklist | Prerequisites | Online setup on GitHub | Troubleshooting | Failing check package on GitHub Actions
Rendered fromgetting_started.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2021-04-23

Setting up checklist for a project
Starting a new project from scratch | Add or update checklist tools in an existing project | To do once after activating version control | Failing checks in the GitHub Action
Rendered fromgetting_started_project.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2023-03-08

Spell checking with checklist
Configuration | Basic usage | Custom dictionary | Rd files | Quarto projects
Rendered fromspelling.Rmdusingknitr::rmarkdown

Last update: 2026-06-22
Started: 2022-09-14

Setting up the integration between GitHub, Zenodo and ORCID
What is Zenodo? | What is ORCID? | Why integrate Zenodo and ORCID with GitHub? | Setup ORCID | Once | Setup Zenodo | Once per repository | What happens next? | Managing Zenodo metadata via DESCRIPTION | Contributor roles | Funding information
Rendered fromzenodo.Rmdusingknitr::rmarkdown

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

File paths in code
Do not use absolute file paths | Easiest solution: use relative paths within the project | Alternative solution: use relative paths between projects | Fallback solution: ask the user to specify the path
Rendered frompath.Rmdusingknitr::rmarkdown

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

Recommended folder structure
For a simple R project | A more complex project | A project with several reports with different data and media
Rendered fromfolder.Rmdusingknitr::rmarkdown

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

Readme and manuals

Help Manual

Help pageTopics
Add AI agentsadd_agents
Add issue and pull request templatesadd_issue_templates
Ask for rights holder or funderask_rightsholder_funder
Sort using the C localec_sort
Run all the package checks required by CRANcheck_cran
Check the 'DESCRIPTION' filecheck_description
Check the documentationcheck_documentation
Make sure that the required environment variables are set on GitHubcheck_environment
Check the style of file and folder namescheck_filename
Check the folder structurecheck_folder
Check the license of a packagecheck_license
Check the packages for linterscheck_lintr
Run the complete set of standardised tests on a packagecheck_package
Run the required quality checks on a projectcheck_project
Standardised test for an R source repositorycheck_source
Spell check a package or projectcheck_spelling
The checklist R6 classchecklist
Clean the git repositoryclean_git
Make hexagonal logo for packagecreate_hexsticker
Create an R package according to INBO requirementscreate_package
Initialise a new R projectcreate_project
Add words to custom dictionariescustom_dictionary
Pass command lines to a shellexecshell
Install extra packages defined in 'checklist.yml'install_pak
Determine if a directory is in a git repositoryis_repository
Check if the current working directory of a repo is cleanis_workdir_clean
Create a new branch after cleaning the reponew_branch
Prepare a 'gh-pages' branch with a place holder pageprepare_ghpages
Display a 'checklist_spelling' summaryprint.checklist_spelling
Read the check list file from a packageread_checklist
Set the proper licenseset_license
Set a New Tagset_tag
Add or update the checklist infrastructure to an existing packagesetup_package
Set-up 'checklist' on an existing R projectsetup_project
Add or update the checklist infrastructure to a repository with source files.setup_source
The spelling R6 classspelling
Make your DESCRIPTION tidytidy_desc
Create or update the citation filesupdate_citation
Write a check list with allowed issues in the source codewrite_checklist
A function that asks a yes or no question to the useryesno