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'))

Peer review:

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

On CRAN:

checklistcontinuous-integrationcontinuous-testingquality-assurance

52 exports 16 stars 2.22 score 113 dependencies 2 dependents 18 scripts

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

TargetResultDate
Doc / VignettesOKAug 18 2024
R-4.5-winOKAug 18 2024
R-4.5-linuxOKAug 18 2024
R-4.4-winOKAug 18 2024
R-4.4-macOKAug 18 2024
R-4.3-winOKAug 18 2024
R-4.3-macOKAug 18 2024

Exports:add_badgesask_yes_nobookdown_zenodoc_sortcheck_codemetacheck_crancheck_descriptioncheck_documentationcheck_environmentcheck_filenamecheck_foldercheck_licensecheck_lintrcheck_packagecheck_projectcheck_sourcecheck_spellingchecklistcitation_metaclean_gitcreate_hexstickercreate_packagecreate_projectcustom_dictionarydefault_organisationexecshellis_repositoryis_workdir_cleanmenu_firstnew_branchorcid2personorganisationprepare_ghpagesread_checklistread_organisationset_licenseset_tagsetup_packagesetup_projectsetup_sourcespellingstore_authorstidy_descupdate_citationuse_authorvalidate_emailvalidate_orcidwrite_checklistwrite_citation_cffwrite_organisationwrite_zenodo_jsonyesno

Dependencies:askpassassertthatbackportsbase64encbrewbriobslibcachemcallrclicliprcodemetacodemetarcodetoolscommonmarkcpp11crayoncredentialscrulcurlcyclocompdescdevtoolsdiffobjdigestdownlitellipsisevaluatefansifastmapfontawesomefsgertghgitcredsgluehighrhtmltoolshtmlwidgetshttpcodehttpuvhttrhttr2hunspellinijquerylibjsonliteknitrlaterlazyevallifecyclelintrmagrittrmemoisemimeminiUIopensslpillarpingrpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRcpprematch2remotesrenvrexrlangrmarkdownroxygen2rprojrootrstudioapirversionssasssessioninfoshinysourcetoolsstringistringrsyssystemfontstestthattextshapingtibbletinytextriebeardurlcheckerurltoolsusethisutf8vctrswaldowhiskerwithrxfunxml2xmlparsedataxopenxtableyamlzip

File paths in code

Rendered frompath.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Organisations

Rendered fromorganisation.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Philosophy of the checklist package

Rendered fromphilosophy.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Recommended folder structure

Rendered fromfolder.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Setting up checklist for a package

Rendered fromgetting_started.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Setting up checklist for a project

Rendered fromgetting_started_project.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Setting up the integration between GitHub, Zenodo and ORCID

Rendered fromzenodo.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Spell checking with checklist

Rendered fromspelling.Rmdusingknitr::rmarkdownon Aug 18 2024.

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

Readme and manuals

Help Manual

Help pageTopics
add badges to a READMEadd_badges
Function to ask a simple yes no questionask_yes_no
Render a 'bookdown' and upload to Zenodobookdown_zenodo
Sort using the C localec_sort
Check the package metadatacheck_codemeta
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
The 'citation_meta' R6 classcitation_meta
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
Write default organisation settingsdefault_organisation
Pass command lines to a shellexecshell
Determine if a directory is in a git repositoryis_repository
Check if the current working directory of a repo is cleanis_workdir_clean
Improved version of menu()menu_first
Create a new branch after cleaning the reponew_branch
Defunct functionsorcid2person
The organisation R6 classorganisation
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
Read the organisation fileread_organisation
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
Store author details for later usagestore_authors
Make your DESCRIPTION tidytidy_desc
Create or update the citation filesupdate_citation
Which author to useuse_author
Check if a vector contains valid emailvalidate_email
Validate the structure of an ORCID idvalidate_orcid
Write a check list with allowed issues in the source codewrite_checklist
Write a 'CITATION.cff' filewrite_citation_cff
Write organisation settingswrite_organisation
Write a '.zenodo.json' filewrite_zenodo_json
A function that asks a yes or no question to the useryesno