Les mystérieuses cités d'or

La bio­in­for­ma­tique est un domaine de recherche donc, avec régu­liè­re­ment de nou­veaux logi­ciels et très souvent​^​*​ votre pre­mier contact avec ce nou­veau logi­ciel se fait via la forge logi­ciel GitHub. Sur GitHub la pre­mière chose que l'utilisateur voit c'est le Readme (pour plus de détails sur ce fichier aller lire cet excellent billet de blog). Ce fichier qui résume l'objectif du projet/​outil, com­ment le compiler/l'installer/l'utiliser (rayer les men­tions inutiles), mais aus­si quand c'est un outil de recherche, quelle publi­ca­tion citer quand on a uti­li­sé l'outil.

Hélas c'est là qu'est l'os, il n'y a pas de norme. De nom­breuses solu­tions coha­bitent : un lien vers la publi­ca­tion, un mor­ceau de code bib­tex, une ligne avec les auteurs et le titre de la publi­ca­tion. Évi­dem­ment tout cela peut être sto­cké dans une sec­tion du Readme ou dans un fichier Citation/CITATION/CITATION.bib/CITATION.md/CiTatIOn.tex.

WSSSPEH Ranger du risque à la rescousse.

En 2017 durant la confé­rence WSSSPE5.1 (Wor­king Towards Sus­tai­nable Soft­ware For Science Pra­tice and Expe­riences) des per­sonnes ont déci­dé de résoudre ce pro­blème en sui­vant la méthode habi­tuelle :

Durant cette confé­rence le for­mat (Cita­tion File For­mat) est pré­sen­té.

En août 2021 GitHub annonce qu'il sup­porte désor­mais le for­mat CFF. Si vous inté­grez un fichier CITATION.cff au for­mat CFF, GitHub rajoute désor­mais dans le pan­neau à gauche de votre Readme un bou­ton "Cite this repo­si­to­ry" qui per­met­tra aux uti­li­sa­teurs de récu­pé­rer les infor­ma­tions dans le for­mat qu'ils sou­haitent (APA et Bib­tex pour l'instant).

Qui qui n'en veut du CFF ?

Le CFF (et pas le CPF) se base sur le for­mat YAML, en voi­ci un petit exemple^​†​:

Rien de très extra­or­di­naire, un résu­mé de la publi­ca­tion, les auteurs avec leurs affi­lia­tions, le titre, la date de la publi­ca­tion, les infor­ma­tions qui sont géné­ra­le­ment liées à une publi­ca­tion scien­ti­fique (allez voir la doc, il y a plein de champs dif­fé­rents dis­po­nibles) mais dans un for­mat lisible à la fois par des humains et des machines.

On peut créer ce fichier à la main, atten­tion à bien res­pec­ter les spé­ci­fi­ca­tions ou uti­li­ser le site web cff init. Si vous avez uti­li­sé Zeno­do sur votre repo­si­to­ry vous pou­vez uti­li­ser doi2cff pour géné­rer auto­ma­ti­que­ment votre fichier CITATION.cff.

Une fois que votre fichier est géné­ré, vous l'ajoutez à la racine de votre dépôt git et voi­là, désor­mais il sera plus simple de citer votre outil, grâce à un bou­ton inté­gré à l'interface de GitHub.

Je tiens à remer­cier les relec­teurs Jona­than, Sébas­tien & Yoann et les admi­nis­tra­teurs du blog.