Package: checklist 0.4.0

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]

checklist_0.4.0.tar.gz
checklist_0.4.0.zip(r-4.5)checklist_0.4.0.zip(r-4.4)checklist_0.4.0.zip(r-4.3)
checklist_0.4.0.tgz(r-4.4-any)checklist_0.4.0.tgz(r-4.3-any)
checklist_0.4.0.tar.gz(r-4.5-noble)checklist_0.4.0.tar.gz(r-4.4-noble)
checklist_0.4.0.tgz(r-4.4-emscripten)checklist_0.4.0.tgz(r-4.3-emscripten)
checklist.pdf |checklist.html✨
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

On CRAN:

checklist continuous-integration continuous-testing quality-assurance

7.04 score 19 stars 2 packages 20 scripts 52 exports 112 dependencies

Last updated 4 months agofrom:5649985b58. Checks:OK: 7. Indexed: yes.

Target	Result	Date
Doc / Vignettes	OK	Nov 16 2024
R-4.5-win	OK	Nov 16 2024
R-4.5-linux	OK	Nov 16 2024
R-4.4-win	OK	Nov 16 2024
R-4.4-mac	OK	Nov 16 2024
R-4.3-win	OK	Nov 16 2024
R-4.3-mac	OK	Nov 16 2024

Exports:add_badges ask_yes_no 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_hexsticker create_package create_project custom_dictionary default_organisation execshell is_repository is_workdir_clean menu_first new_branch orcid2person 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 cyclocomp 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 lazyeval lifecycle lintr magrittr memoise mime miniUI openssl pillar pingr pkgbuild pkgconfig pkgdown pkgload praise prettyunits processx profvis promises ps purrr R6 ragg rappdirs rcmdcheck Rcpp remotes renv rex rlang rmarkdown roxygen2 rprojroot rstudioapi rversions sass sessioninfo shiny sourcetools stringi stringr sys systemfonts testthat textshaping tibble tinytex triebeard urlchecker urltools usethis utf8 vctrs waldo whisker withr xfun xml2 xmlparsedata xopen xtable yaml zip

File paths in code

Rendered frompath.Rmdusingknitr::rmarkdownon Nov 16 2024.

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

Organisations

Rendered fromorganisation.Rmdusingknitr::rmarkdownon Nov 16 2024.

Last update: 2024-05-30
Started: 2024-05-30

Philosophy of the checklist package

Rendered fromphilosophy.Rmdusingknitr::rmarkdownon Nov 16 2024.

Last update: 2022-09-14
Started: 2021-04-23

Recommended folder structure

Rendered fromfolder.Rmdusingknitr::rmarkdownon Nov 16 2024.

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

Setting up checklist for a package

Rendered fromgetting_started.Rmdusingknitr::rmarkdownon Nov 16 2024.

Last update: 2024-05-30
Started: 2021-04-23

Setting up checklist for a project

Rendered fromgetting_started_project.Rmdusingknitr::rmarkdownon Nov 16 2024.

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

Setting up the integration between GitHub, Zenodo and ORCID

Rendered fromzenodo.Rmdusingknitr::rmarkdownon Nov 16 2024.

Last update: 2024-05-30
Started: 2022-01-19

Spell checking with checklist

Rendered fromspelling.Rmdusingknitr::rmarkdownon Nov 16 2024.

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
Function to ask a simple yes no question	ask_yes_no
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
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
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
Defunct functions	orcid2person
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