LoginSign Up
← Back to all sparks
C

checklist

ANALYTICS
Velocity0.0

A Thorough and Strict Set of Checks for R Packages and Source Code

github.com/inbo/checklist ↗

An institutional R quality-control package that just split its citation half into its own tool.

quality-controlr-packageresearch-metadatainbogithub-actions
◆Current state
checklist enforces coding, documentation and metadata standards for R packages and projects at INBO, the Flemish research institute for nature and forest, and runs as both a local tool and a GitHub Action. Much of its work concerns research-output metadata — Zenodo deposits, DOIs, ORCID, ROR identifiers, organisation records — rather than code style. Its most recent major release removed that entire area from the package.
◆Where it's heading
The direction is decomposition. An organisation class was first superseded by a more structured pair of classes, and then the whole citation and deposit surface moved out to a separate citeme package, leaving checklist focused on project and package checking. The sibling INBOmd package picked up the new dependency within a week, which is how this family propagates a change. What remains here is narrower and more clearly named than what it started with.
◆Prediction
Expect checklist to continue tightening its remaining project-checking scope, with further citation and metadata work landing in citeme rather than here.

◆Recent moves

  1. 1mo ago

    Organisation now passed correctly when creating a package skeleton

    Fixes the organisation not being passed through when generating a package skeleton, and improves the bug report template. Fallout from the class restructuring in the preceding releases. No change in capability.

    View source ↗
  2. 1mo ago

    Citation and Zenodo functions split out into the citeme package

    ⚡ SPARK

    The structural release of this window: roughly fifteen citation, organisation and Zenodo functions leave checklist for the new citeme package, bookdown_zenodo() and check_codemeta() are removed, and add_badges() is renamed. It resolves the long-standing tension in a package that was doing both code quality control and research-output metadata. The sibling INBOmd adopted the new dependency six days later.

    View source ↗
  3. 5mo ago

    Zenodo deposits gain publisher, EU grant IDs and ROR handling

    Adds a publisher field to .zenodo.json, grant IDs for EU-funded Zenodo communities, and correct handling of ROR organisation identifiers, plus a DOI badge fix. Unglamorous metadata plumbing, but these fields are what make a deposit discoverable and correctly attributed to its funder. All of this surface moved to citeme four months later.

    View source ↗
  4. 7mo ago

    Contributing and conduct files created only when requested

    Stops generating contributing guidelines and a code of conduct unless the user answers yes to the corresponding prompts. A small correction to the interactive setup flow, of the kind that accumulates in a tool that scaffolds files on the user's behalf.

    View source ↗
  5. 8mo ago

    GitHub Action restores renv environments and installs system dependencies

    The check_project action now restores the R environment through renv when a renv.lock is present and gains an APTGET argument for installing system dependencies. Also fixes check_license() failing when README.md carries no usable licence information. The action changes matter more than they look: without renv restoration, checks ran against a different dependency set than the project declares.

    View source ↗
  6. 8mo ago

    organisation class superseded by org_list and org_item

    Replaces the single organisation class with a structured org_list and org_item pair, deprecating the old class and its read and write functions, and enforcing the INBO ROR identifier in the new representation. New constructors build the list from interactive questions or from the git remote. This is the first move of the decomposition that culminated in the citeme split, restructuring the organisation data before relocating it entirely.

    View source ↗