Name: Checklist Improves Collaboration, Quality and Visibility of Your Code - Thierry Onkelinx, Research Institute for Nature and Forest
Start: 2024-07-09T13:40:00+0200
End: 2024-07-09T13:45:00+0200

In Person & Virtual
8 - 11 July, 2024
Learn more and Register to Attend

The Sched app allows you to build your schedule but is not a substitute for your event registration. You must be registered for useR! 2024 to participate in the sessions. If you have not registered but would like to join us, please go to the event registration page to purchase a registration.

Please note: This schedule is automatically displayed in Central European Time (UTC+1). To see the schedule in your preferred timezone, please select from the drop-down menu to the right, above "Filter by Date." The schedule is subject to change.

Back To Schedule

Checklist Improves Collaboration, Quality and Visibility of Your Code - Thierry Onkelinx, Research Institute for Nature and Forest

The checklist package is a set of rules for R packages and R source code projects. The ruleset covers several topics: folder structure, filename conventions, spelling, code style, citation metadata, licence, contribution guidelines, ... Adherence to a common set of rules within an organisation facilitates collaboration between its members. Enforcing citation metadata and an open source licence improves the visibility of projects. Automated checks via GitHub Actions detect problems as soon as possible. Checklist is based on the rcmdcheck, lintr, pkgdown, codemetar and hunspell packages. Where applicable, we use the same rules for projects and packages. The maintainer can choose which parts of the ruleset apply to a project. In the case of an R package, the entire ruleset is mandatory. Publishing code on Zenodo is easy if you link to your GitHub repository. Each release on GitHub triggers a new version on Zenodo with a specific DOI. A GitHub action creates a new release for each new version of the package. Documentation and source code is available on https://inbo.github.io/checklist

Speakers

Thierry Onkelinx

statistician, Research Institute for Nature and Forest

statistician at the Research Institute for Nature and Forest

Tuesday July 9, 2024 13:40 - 13:45 CEST
Pinzgau + Tennegau

R workflow + deployment + production, Lightning Talk

Feedback form isn't open yet.

useR! 2024

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Thierry Onkelinx