# CHECK-LISTE POUR LA DOCUMENTATION ET LA CITATION DES DONNÉES

Romain David, Solange Santos, Shelley Stall, Alison Specht, Pedro Luiz Pizzigatti Corrêa, Jeaneth Machicao, Nobuko Miyairi, Yasuhiro Murayama, Margaret O'Brien, Lesley Wyborn, et al.

► To cite this version:

Romain David, Solange Santos, Shelley Stall, Alison Specht, Pedro Luiz Pizzigatti Corrêa, et al. CHECK-LISTE POUR LA DOCUMENTATION ET LA CITATION DES DONNÉES. 2023, 10.5281/zenodo.7847718. hal-04829015

HAL Id: hal-04829015

https://hal.science/hal-04829015v1

Submitted on 10 Dec 2024

HAL is a multi-disciplinary open access
archive for the deposit and dissemination of sci-
entific research documents, whether they are pub-
lished or not. The documents may come from
teaching and research institutions in France or
abroad, or from public or private research centers.

L'archive ouverte pluridisciplinaire HAL, est
destinée au dépôt et à la diffusion de documents
scientifiques de niveau recherche, publiés ou non,
émanant des établissements d'enseignement et de
recherche français ou étrangers, des laboratoires
publics ou privés.

<figure><img src="image_1.png" /></figure>

Distributed under a Creative Commons Attribution 4.0 International License
# Partagez vos données –
CHECK-LISTE POUR LA DOCUMENTATION ET
LA CITATION DES DONNÉES

Bienvenue dans "Votre parcours pour la Science Ouverte"!

Planifiez, gérez et partagez vos données. Utilisez cette check-liste pour améliorer vos pratiques de gestion et de partage des données.

## Audience cible

Principale: Équipes ou chercheur.e.s dans le cadre de projets

Secondaire: Équipes ou responsables de projets

Cette check-liste est générique et devra être ajustée en fonction des exigences de votre établissement, laboratoire, équipe de recherche et/ou financeur.

## A. PLANIFIEZ ET GÉREZ VOS DONNÉES PENDANT VOTRE PROJET DE RECHERCHE

### 1. Organisez vos fichiers de données et leurs formats :

a. **Utilisez des formats non propriétaires (par exemple, des tableaux en texte brut) et des formats de fichiers de compression qui ne perdent pas d'informations (par exemple, TIFF) pour garantir un accès à long terme.** Les formats de fichiers cryptés peuvent être problématiques pour un accès futur. Les alternatives open source pour les logiciels spécialisés utilisés dans l'analyse sont également préférées.

b. **Choisissez des noms de fichiers descriptifs et utiles que les humains et les machines peuvent lire.** Des exemples d'idées pour améliorer la convention de nom de fichier peuvent inclure, 1) L'utilisation de délimiteurs choisis tels que "-" pour relier les termes ensemble et "_" pour séparer différentes informations ; 2) Éviter les caractères spéciaux (par exemple, $), les espaces et la ponctuation ; 3) Créer des noms significatifs et des métadonnées qui soient explicites sur le contenu ; 4) Utiliser des méthodes qui facilitent le tri par défaut telles que le format de date AAAA-MM-JJ (norme internationale). Voir Jenny Bryan *How to name files*.

c. **Organisez techniquement vos données selon des standards de haute qualité.** Pour des informations générales sur l'organisation des données, voir le Référentiel EDI Guidelines for cleaning data.

d. **Déterminez la structure hiérarchique des dossiers et des fichiers pour le projet.** Soyez cohérent, utilisez UN répertoire pour UN projet, organisé par fonction (par exemple, données, code) et par sortie (par exemple, figures, résultats). Assurez-vous que les données brutes d'origine sont séparées, ne peuvent pas être modifiées et que des copies des données brutes sont modifiables. Pour plus d'informations, reportez-vous aux recommandations "compendium file-structure" développé par The Turing Way.

e. **Créez un ou plusieurs fichiers README ou LISEZMOI pour fournir des informations sur les données.** Prévoyez de relever les informations au fur et à mesure que vous les collectez pour vous assurer que les données peuvent être correctement interprétées à une date ultérieure. Incluez les éléments de base qui vous aideront également à créer des métadonnées pour un jeu de données.
<figure><img src="image_2.png" /></figure>

* En fonction de la structure et de la complexité de votre fichier, vous souhaiterez peut-être un fichier README pour chaque jeu de données ainsi qu'un fichier décrivant la structuration complète des fichiers (également appelé « répertoire de fichiers »).

* Incluez ces éléments dans votre fichier README : Titre, coordonnées des enquêteurs, date(s) de collecte, informations géographiques, termes descriptifs, informations linguistiques, sources de financement, informations de partage/d'accès, aperçu des données et des fichiers, informations méthodologiques et informations spécifiques sur les données. Voir Guide to writing "readme" style metadata de Cornell University qui inclut une matrice téléchargeable de fichier README. Voir aussi le Smithsonian Libraries' Describing Your Data: Data Dictionaries. Pour l'information générale sur les métadonnées, voir le référentiel EDI Creating metadata.

* Gardez votre fichier README à jour.

2. **Gérez vos données plus efficacement avec des outils de gestion de versions, de workflows et les cahiers de laboratoire électroniques (notebooks):**

a. **Utilisez un système de contrôle de version pour suivre les modifications de fichiers** ou l'historique d'un projet (par exemple, étapes d'acquisition, reformatage). Des plateformes telles que GitHub, GitLab, ou Open Science Framework (OSF) offrent des capacités supplémentaires de sauvegarde collaboratives et en ligne.

b. **Utilisez un outil de gestion des workflows** pour créer des analyses de données reproductibles et évolutives. Les langages de workflows tels que le Common Workflow Language (CWL) offrent un moyen d'ajouter des descriptions dans les outils de création de lignes de commandes et de les connecter pour créer des workflows. Des options similaires existent dans Snakemake, Nextflow, Galaxy.

c. Pour les laboratoires, envisagez un **cahier de laboratoire électronique (notebook)** pour documenter les recherches, les expériences et les procédures. Les cahiers de notes de laboratoire tels que RSpace offrent des fonctionnalités pour se connecter aux workflows de recherche et pour documenter et partager vos recherches plus efficacement.

d. **Prenez connaissance et respectez les licences d'utilisation et/ou les accords de partage de données** pour les données précédemment créées/collectées par vous ou d'autres personnes.

3. **Stockez et sauvegardez vos fichiers de données:**

a. **Protégez vos fichiers en vous assurant qu'ils sont automatiquement sauvegardés par un système de confiance.** Profitez des services de sauvegarde de votre établissement s'ils sont offerts. Il est préférable que le système de sauvegarde se trouve dans un emplacement géographique différent (par exemple, un service de stockage dans le "cloud").

B. PARTAGEZ VOS DONNÉES OUVERTEMENT

Suivez ces étapes lorsque votre recherche passe un cap et avant la publication.

1. **Sélectionnez votre entrepôt pour la conservation de vos données:**

a. **Planifiez l'endroit où vous déposerez vos propres données** vous aidera à les structurer et à les documenter plus efficacement pour un partage ultérieur. Utilisez pour cela le Repository Guidance.

2. Déterminez quelles sont les données à preserver:
<figure><img src="image_3.png" /></figure>

a. **Les données que vous avez collectées ou créées (par exemple, primaires) et les données traitées** utilisées pour votre recherche doivent être conservées et mises à disposition pour permettre aux autres lecteurs d'évaluer vos conclusions et de développer votre travail.

b. **Pour les données de modèle ou de simulation**, le modèle et la configuration doivent généralement être conservés. La communauté des modèles EarthCube a développé un cadre (framework to guide), facile à adapter, pour vous indiquer ce qu'il faut préserver de vos recherches.

c. **Pour les données très volumineuses** (supérieures à 1 Téraoctet), il peut être difficile de les conserver, car des frais et des ressources supplémentaires sont souvent nécessaires. Une option à considerer: les institutions proposent souvent des solutions pour la préservation et la conformité des données. D'autres solutions sont fournies dans cet article de blog. [Lien Internet Archive].

### 3. Documentez vos données avant de les déposer - Fichiers README, métadonnées et licences:

a. **Préparez vos métadonnées (recommandé)**

De nombreux entrepôts d'archivage de données fournissent des conseils sur le type de documentation nécessaire pour rendre vos données compréhensibles (par exemple, EDI Repository guidance). Lorsque ces instructions ne sont pas disponibles, suivez les instructions du fichier README (voir section A.1.e ci-dessus).

b. **Attribuez une licence à vos données (obligatoire)**

Sélectionnez les licences en fonction du type d'utilisation que vous envisagez pour vos propres données. Pour encourager la réutilisation par d'autres, rendez vos données aussi ouvertement accessibles que possible. Les licences à privilégier sont CC0 ou CC-BY 4.0. Voir [Creative Commons](https://creativecommons.org/licenses/by/4.0/).

### 4. Déposez vos données auprès de l'entrepôt sélectionné:

a. **Suivez les conseils** de l'entrepôt sélectionné:

* Incluez vos fichiers README et/ou Metadata

* Identifiez la licence de votre choix. Ceci est probablement géré par l'entrepôt, mais si ce n'est pas le cas, incluez des informations identifiant la licence souhaitée.

b. Assurez-vous que l'entrepôt affiche clairement votre citation sous la forme de votre choix.

## C. CITEZ TOUTES LES DONNÉES

1. **Incluez des citations de données** pour les données de recherche (primaires et traitées) que vous avez utilisées (cela inclut les données que vous avez créées ainsi que toutes les données créées par d'autres) dans la section Références de votre article. Cela garantit que le crédit approprié est attribué aux données.

2. **Incluez une déclaration de disponibilité des données** dans votre document qui décrit où et comment vos données sont disponibles, en y incluant un moyen en ligne d'accéder à vos données. Vérifiez les liens et les fichiers de données avant de soumettre votre article à la revue afin de vous assurer que les données sont accessibles pour l'examen de l'article par les pairs.

3. Utilisez la déclaration de disponibilité et la check-liste des citations d'AGU (the availability statement and citation checklist), par exemple, pour vous assurer que vos citations et déclarations de disponibilité sont complètes. Voir [Data and Software Sharing Guidance for](https://www.ecosystem.com/data-and-software-sharing-guidance-for).
Authors pour plus de conseils sur le partage de données et de logiciels pour les auteurs.e.s d'AGU.

Liens rapides vers les check-listes connexes:

- Check-liste présence numérique

- Check-liste pour la Documentation et la Citation des Logiciels

Pour suggérer des mises à jour, svp envoyez un email à datahelp@agu.org. Incluez le DOI et le nom de la check-liste dans votre email, merci.

Pour citer cette check-liste: David, Romain, Santos, Solange, Stall, Shelley, Specht, Alison, Corrêa, Pedro Luiz Pizzigatti, Machicao, Jeaneth, Miyairi, Nobuko, Murayama, Yasuhiro, O'Brien, Margaret, Wyborn, Lesley, Vellenich, Danton Ferreira, & Mabile, Laurence. Check-liste pour la Documentation et la Citation des Données. Zenodo. https://doi.org/10.5281/zenodo.7847718

Traduction de l'anglais : Romain David, Laurence Mabile