un fichier readme fournit des informations sur un fichier de données et vise à garantir que les données peuvent être interprétées correctement, par vous-même à une date ultérieure ou par d’autres personnes lors du partage ou de la publication de données. Les métadonnées basées sur des normes sont généralement préférables, mais lorsqu’il n’existe pas de norme appropriée, pour un usage interne, l’écriture de métadonnées de style « readme” est une stratégie appropriée.

Voulez un modèle?, Téléchargez-en un et adaptez – le à vos propres données!

  • les Meilleures pratiques
  • contenu Recommandé
    • informations Générales
    • des Données et des fichiers vue d’ensemble
    • le Partage et l’accès de l’information
    • des informations Méthodologiques
    • Données spécifiques d’information
  • des informations Connexes

Les meilleures pratiques

Créer des fichiers readme pour la logique de « clusters » de données. Dans de nombreux cas, il sera approprié de créer un document pour un ensemble de données qui contient plusieurs fichiers associés au même format, ou des fichiers qui sont logiquement regroupés pour être utilisés (par exemple, une collection de scripts Matlab). Parfois, il peut être judicieux de créer un fichier lisez-moi pour un seul fichier de données.

nommez le fichier readme afin qu’il soit facilement associé au(X) Fichier (s) de données qu’il décrit.

écrivez votre document readme en tant que fichier texte brut, en évitant les formats propriétaires tels que MS Word lorsque cela est possible. Formatez le document readme pour qu’il soit facile à comprendre (par exemple, séparez les informations importantes avec des lignes vides, plutôt que d’avoir toutes les informations dans un long paragraphe).

formatez plusieurs fichiers readme de manière identique., Présentez les informations dans le même ordre, en utilisant la même terminologie.

utilisez des formats de date normalisés. Format suggéré: norme de date W3C / ISO 8601, qui spécifie la notation standard internationale de AAAA-MM-JJ ou AAAA-MM-Jjthh: mm: SS.

suivez les conventions scientifiques de votre discipline pour les noms et mots-clés taxonomiques, géospatiaux et géologiques. Dans la mesure du possible, utilisez des termes issus de taxonomies et de vocabulaires normalisés, dont quelques-uns sont énumérés ci-dessous.

contenu recommandé

le contenu minimum recommandé pour la réutilisation des données est en gras.,de données spécifiques

*répétez cette section au besoin pour chaque ensemble de données (ou fichier, selon le cas)*

  1. Nombre de variables et nombre de cas ou de lignes
  2. liste des variables, y compris les noms complets et les définitions (épeler les mots abrégés) des en-têtes de colonne pour les données tabulaires
  3. Unités de mesure
  4. définitions des codes ou Symboles utilisés pour enregistrer les données manquantes
  5. formats spécialisés ou autres abréviations utilisées

vous voulez un modèle?, Téléchargez-en un et adaptez – le à vos propres données!

Les lignes directrices précédentes ont été adaptées à partir de plusieurs sources, y compris:

meilleures pratiques pour la création de publications de données réutilisables. Dryade. 2019. https://datadryad.org/stash/best_practices

les formats de Fichiers. Recherche De Cornell De Données De Service De Gestion De Groupe. http://data.research.cornell.edu/content/file-formats

Introduction aux Droits de Propriété Intellectuelle dans la Gestion des Données. Recherche De Cornell De Données De Service De Gestion De Groupe. http://data.research.cornell.edu/content/intellectual-property

métadonnées et description des données. Recherche De Cornell De Données De Service De Gestion De Groupe. http://data.research.cornell.edu/content/writing-metadata