{"id":14067441,"url":"https://github.com/inbo/checklist","last_synced_at":"2026-01-16T03:45:37.659Z","repository":{"id":40692498,"uuid":"277477810","full_name":"inbo/checklist","owner":"inbo","description":"An R package for checking R packages and R code","archived":false,"fork":false,"pushed_at":"2025-04-18T13:00:26.000Z","size":2991,"stargazers_count":18,"open_issues_count":9,"forks_count":2,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-24T06:02:17.860Z","etag":null,"topics":["checklist","continuous-integration","continuous-testing","quality-assurance","r"],"latest_commit_sha":null,"homepage":"https://inbo.github.io/checklist","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inbo.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":".zenodo.json"}},"created_at":"2020-07-06T07:53:41.000Z","updated_at":"2025-04-18T12:45:18.000Z","dependencies_parsed_at":"2023-02-15T11:15:44.753Z","dependency_job_id":"36a5d565-789d-43d2-bff4-6abebabc0a36","html_url":"https://github.com/inbo/checklist","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inbo%2Fchecklist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inbo%2Fchecklist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inbo%2Fchecklist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inbo%2Fchecklist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inbo","download_url":"https://codeload.github.com/inbo/checklist/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252088460,"owners_count":21692798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checklist","continuous-integration","continuous-testing","quality-assurance","r"],"created_at":"2024-08-13T07:05:35.785Z","updated_at":"2026-01-16T03:45:37.650Z","avatar_url":"https://github.com/inbo.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n\u003c!-- badges: start --\u003e\n[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing-1)\n![GitHub](https://img.shields.io/github/license/inbo/checklist)\n[![Release](https://img.shields.io/github/release/inbo/checklist.svg)](https://github.com/inbo/checklist/releases)\n[![R build status](https://github.com/inbo/checklist/actions/workflows/check_on_main.yml/badge.svg)](https://github.com/inbo/checklist/actions)\n![r-universe name](https://inbo.r-universe.dev/badges/:name?color=c04384)\n![r-universe package](https://inbo.r-universe.dev/badges/checklist)\n[![Codecov test coverage](https://codecov.io/gh/inbo/checklist/branch/main/graph/badge.svg)](https://app.codecov.io/gh/inbo/checklist?branch=main)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/inbo/checklist.svg)\n![GitHub repo size](https://img.shields.io/github/repo-size/inbo/checklist.svg)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4028303.svg)](https://doi.org/10.5281/zenodo.4028303)\n\u003c!-- badges: end --\u003e \n\n# The Checklist Package \u003cimg src=\"man/figures/logo.svg\" align=\"right\" alt=\"A hexagon with the word checklist\" width=\"120\" /\u003e\n\n```{r setup, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE, comment = \"#\u003e\", fig.path = \"man/figures/README-\",\n  out.width = \"100%\", eval = FALSE\n)\n```\n\nThe goal of `checklist` is to provide an elaborate and strict set of checks for R packages and R code.\n\n## Installation\n\nYou can install the package from the [INBO universe](https://inbo.r-universe.dev/builds) via\n\n```{r universe}\n# Enable the INBO universe\noptions(\n  repos = c(\n    inbo = \"https://inbo.r-universe.dev\", CRAN = \"https://cloud.r-project.org\"\n  )\n)\n# Install the packages\ninstall.packages(\"checklist\", dependencies = TRUE)\n```\n\nIf that doesn't work, you can install the version from [GitHub](https://github.com/inbo/checklist/) with:\n\n```{r installation}\n# install.packages(\"remotes\")\nremotes::install_github(\"inbo/checklist\", dependencies = TRUE)\n```\n\n## Setting a default organisation\n\nOriginally, we created `checklist` with the Research Institute for Nature and Forest (INBO) in mind.\nWe recommend that you set a default organisation list.\nMore details in `vignette(\"organisation\", package = \"checklist\")`.\n\n## Using `checklist` on a package.\n\nBefore you can run the checks, you must initialise `checklist` on the package.\nEither use `create_package()` to create a new package from scratch.\nOr use `setup_package()` on an existing package.\nMore details in `vignette(\"getting_started\", package = \"checklist\")`.\n\n```{r package-initialise}\ncreate_package()\n```\n\nOnce initialised, you can run all the checks with `check_package()`.\nOr run the individual checks.\n\n```{r package-checks}\ncheck_cran()\ncheck_description()\ncheck_documentation()\ncheck_lintr()\ncheck_filename()\ncheck_folder()\nupdate_citation()\n```\n\nTo allow some of the warnings or notes, first run the checks and store them in an object.\nUpdate `checklist.yml` by writing that object.\n\n```{r package-allow-warnings}\nx \u003c- check_package()\nwrite_checklist(x)\n```\n\n## Using `checklist` on a project.\n\nBefore you can run the checks, you must initialise `checklist` on the project.\nEither use `create_project()` to create a new package from scratch.\nOr use `setup_project()` on an existing package.\nMore details in `vignette(\"getting_started_project\", package = \"checklist\")`.\n\n```{r project-initialise}\nlibrary(checklist)\ncreate_project()\n```\n\nOnce initialised, you can run all the checks with `check_project()`.\nOr run the individual checks.\n\n```{r project-checks}\ncheck_lintr()\ncheck_filename()\ncheck_folder()\nupdate_citation()\n```\n\nTo allow some of the warnings or notes, first run the checks and store them in an object.\nUpdate `checklist.yml` by writing that object.\n\n\n```{r project-allow-warnings}\nx \u003c- check_project()\nwrite_checklist(x)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finbo%2Fchecklist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finbo%2Fchecklist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finbo%2Fchecklist/lists"}