Man pages for inbo/checklist
A Thorough and Strict Set of Checks for R Packages and Source Code
| add_badges | add badges to a README |
| ask_yes_no | Function to ask a simple yes no question |
| author2df | Convert person object in a data.frame. |
| bookdown_zenodo | Render a 'bookdown' and upload to Zenodo |
| check_codemeta | Check the package metadata |
| 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... |
| check_filename | Check the style of file and folder names |
| check_folder | Check the folder structure |
| check_license | Check the license of a package |
| check_lintr | Check the packages for linters |
| checklist | The checklist R6 class |
| check_package | Run the complete set of standardised tests on a package |
| check_project | Run the required quality checks on a project |
| check_source | Standardised test for an R source repository |
| check_spelling | Spell check a package or project |
| citation_meta | The 'citation_meta' R6 class |
| clean_git | Clean the git repository |
| create_draft_pr | Create a draft pull request |
| create_hexsticker | Make hexagonal logo for package |
| create_package | Create an R package according to INBO requirements |
| create_project | Initialise a new R project |
| c_sort | Sort using the C locale |
| custom_dictionary | Add words to custom dictionaries |
| default_organisation | Write default organisation settings |
| defunct | Defunct functions |
| execshell | Pass command lines to a shell |
| 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 |
| menu_first | Improved version of menu() |
| new_branch | Create a new branch after cleaning the repo |
| organisation | The organisation R6 class |
| prepare_ghpages | Prepare a 'gh-pages' branch with a place holder page |
| print.checklist_spelling | Display a 'checklist_spelling' summary |
| read_checklist | Read the check list file from a package |
| read_organisation | Read the organisation file |
| set_license | Set the proper license |
| set_tag | Set a New Tag |
| setup_package | Add or update the checklist infrastructure to an existing... |
| setup_project | Set-up 'checklist' on an existing R project |
| setup_source | Add or update the checklist infrastructure to a repository... |
| spelling | The spelling R6 class |
| store_authors | Store author details for later usage |
| tidy_desc | Make your DESCRIPTION tidy |
| update_citation | Create or update the citation files |
| use_author | Which author to use |
| validate_email | Check if a vector contains valid email |
| validate_orcid | Validate the structure of an ORCID id |
| write_checklist | Write a check list with allowed issues in the source code |
| write_citation_cff | Write a 'CITATION.cff' file |
| write_organisation | Write organisation settings |
| write_zenodo_json | Write a '.zenodo.json' file |
| yesno | A function that asks a yes or no question to the user |
