Skip to contents

Functions relevant for checking packages

check_package()
Run the complete set of standardised tests on a package
check_cran()
Run all the package checks required by CRAN
check_description()
Check the DESCRIPTION file
check_documentation()
Check the documentation
check_environment()
Make sure that the required environment variables are set on GitHub
check_license()
Check the license of a package
tidy_desc()
Make your DESCRIPTION tidy

Functions relevant for checking projects with R and Rmd scripts

check_folder()
Check the folder structure
check_project()
Run the required quality checks on a project
check_source()
Standardised test for an R source repository

Functions relevant for checking packages and projects

add_agents()
Add AI agents
add_issue_templates()
Add issue and pull request templates
check_filename()
Check the style of file and folder names
check_lintr()
Check the packages for linters
check_spelling()
Spell check a package or project
custom_dictionary()
Add words to custom dictionaries
print(<checklist_spelling>)
Display a checklist_spelling summary
read_checklist()
Read the check list file from a package
update_citation()
Create or update the citation files
write_checklist()
Write a check list with allowed issues in the source code

Setting up a project use the checklist package

create_package()
Create an R package according to INBO requirements
create_project()
Initialise a new R project
prepare_ghpages()
Prepare a gh-pages branch with a place holder page
set_license()
Set the proper license
setup_package()
Add or update the checklist infrastructure to an existing package
setup_project()
Set-up checklist on an existing R project
setup_source()
Add or update the checklist infrastructure to a repository with source files.
clean_git()
Clean the git repository
is_repository()
Determine if a directory is in a git repository
is_workdir_clean()
Check if the current working directory of a repo is clean
new_branch()
Create a new branch after cleaning the repo
set_tag()
Set a New Tag

R6 classses behind the checklist package

checklist
The checklist R6 class
spelling
The spelling R6 class

Auxiliary functions

ask_rightsholder_funder()
Ask for rights holder or funder
c_sort()
Sort using the C locale
create_hexsticker()
Make hexagonal logo for package
execshell()
Pass command lines to a shell
install_pak()
Install extra packages defined in checklist.yml
yesno()
A function that asks a yes or no question to the user