Formats ouverts pour les échanges de recherche

Utilisez ces lignes directrices avec les normes de contribution partagées. Utilisez des formats que les collaborateurs peuvent inspecter, échanger et réutiliser avec des outils couramment disponibles. Commencez par les valeurs par défaut ci-dessous et conservez la source native lorsqu'une exportation perdrait un sens scientifique ou une éditabilité.

Matériau Par défaut pratique
Notes, protocoles et documentation UTF-8 Markdown; exporter le PDF lorsqu'une copie de lecture fixe est utile.
Petits tableaux UTF-8 CSV avec dictionnaire ou schéma de données.
Tables dactylographiées plus grandes Parquet avec dictionnaire et version lecteur/bibliothèque; offrir un petit exemple de CSV quand il est utile.
Enregistrements et échanges structurés JSON; JSONL pour un disque par ligne. Inclure un schéma lorsque les champs doivent être validés.
Configuration éditée par l'homme YAML ou JSON, avec la version supportée et un exemple.
Références BibTeX, RIS ou CSL JSON, conservant le DOI ou d'autres identifiants stables.
Figures et diagrammes Source modifiable et SVG le cas échéant; PNG pour les images raster et PDF pour les copies de publication fixes.

Le CSV seul ne préserve pas les types de champs ni n’explique la signification des valeurs. Enregistrez les définitions de colonnes, les types, les unités, les codes de valeurs manquantes, les formats de date et les fuseaux horaires, les identifiants et les relations entre les tables. Conservez les identifiants avec des zéros non significatifs sous forme de chaînes. Un petit dictionnaire suffit pour un simple tableau ; Métadonnées CSV W3C offre une option lisible par machine. Parquet Préserve les champs dactylographiés mais a encore besoin de descriptions de leur signification et de leur origine.

Utiliser des formats de domaine lorsqu'ils préservent la recherche mieux qu'un tableau général. Parmi les exemples, mentionnons le SBML ou le CellML pour les modèles biologiques appropriés et le FMI pour l'échange de modèles soutenu ou la co--simulationC'est vrai. NetCDF ou HDF5 peuvent prendre en charge des réseaux scientifiques appropriés, et STEP peut prendre en charge les échanges CAO. Gardez le modèle natif, les entrées de solveur, les systèmes de coordonnées, les unités, les dépendances et les versions de format nécessaires pour l'interpréter ou le réutiliser. Vérifiez une exportation d'échange dans l'outil de réception avant de la traiter comme équivalente à sa source.

Gardez la source et son histoire#

Conserver les sources modifiables à côté des copies de lecture ou les relier à travers un manifeste en version. Enregistrez la version source, le script de transformation ou les paramètres d'exportation, la version logicielle et toute information perdue. Un tableur peut demeurer une source de travail modifiable. Exportez ses tables d'échange et conservez les formules et transformations nécessaires pour les reproduire. Un PDF ou une capture d'écran seule est généralement insuffisant pour des données réutilisables ou un modèle.

Conservez les petites sources, les schémas, les scripts et les métadonnées dans Git. Mettre de grands artefacts et du matériel restreint dans un stockage externe approprié. Suivre un manifeste partageable contenant des ID d'artefact, des versions, des emplacements, des comptes de vérification, le cas échéant, de la provenance, des conditions d'accès et des instructions de régénération. Conservez les chemins et métadonnées confidentiels dans l'enregistrement contrôlé au besoin.

Un format ouvert ne rend pas son contenu open data. Énoncez séparément les conditions de licence ou d’accès, conservez l’attribution et vérifiez ce qui peut être partagé. Utilisez le processus de demande de ressources lorsque l'accès nécessite un administrateur. Ces par défaut complètent la normes de contribution; les projets peuvent documenter un meilleur format pour leurs méthodes.

Afficher la source sur GitHub