Un file readme fornisce informazioni su un file di dati e ha lo scopo di aiutare a garantire che i dati possano essere interpretati correttamente, da soli in un secondo momento o I metadati basati su standard sono generalmente preferibili, ma dove non esiste uno standard appropriato, per uso interno, scrivere metadati in stile “readme” è una strategia appropriata.

Vuoi un modello?, Scarica uno e adattarlo per i propri dati!

  • Best practice
  • contenuto Raccomandato
    • informazioni Generali
    • Dati e file panoramica
    • Condivisione e l’accesso a informazioni
    • informazioni Metodologiche
    • Dati specifiche di informazione;
  • informazioni Correlate

Best practice

Crea file readme per la logica di “gruppi” di dati. In molti casi sarà opportuno creare un documento per un set di dati che ha più file, correlati, formattati in modo simile, o file che sono logicamente raggruppati insieme per l’uso (ad esempio, una raccolta di script Matlab). A volte può avere senso creare un readme per un singolo file di dati.

Denomina il readme in modo che sia facilmente associato ai file di dati che descrive.

Scrivi il tuo documento readme come un file di testo normale, evitando formati proprietari come MS Word quando possibile. Formattare il documento readme in modo che sia facile da capire (ad esempio separare pezzi importanti di informazioni con righe vuote, piuttosto che avere tutte le informazioni in un lungo paragrafo).

Formatta più file readme in modo identico., Presentare le informazioni nello stesso ordine, utilizzando la stessa terminologia.

Utilizzare formati di data standardizzati. Formato suggerito: W3C / ISO 8601 data standard, che specifica la notazione standard internazionale di AAAA-MM-GG o AAAA-MM-DDThh: mm: ss.

Segui le convenzioni scientifiche per la tua disciplina per nomi e parole chiave tassonomici, geospaziali e geologici. Quando possibile, utilizzare termini da tassonomie e vocabolari standardizzati, alcuni dei quali sono elencati di seguito.

Contenuto consigliato

Il contenuto minimo consigliato per il riutilizzo dei dati è in grassetto.,di

  • Persone coinvolte con la raccolta del campione, elaborazione, analisi e/o di presentazione

    • Dati-informazioni specifiche

    *Ripetere questa sezione necessari per ogni set di dati (o file, come appropriato)*

    1. numero di variabili, e il numero di casi o righe
    2. lista delle Variabili, tra i nomi completi e definizioni (compitare parole abbreviati) di intestazioni di colonna per tabulare i dati
    3. Unità di misura
    4. le Definizioni dei codici o dei simboli utilizzati per registrare dati mancanti
    5. formati speciali o altre abbreviazioni usate

    Volete un modello?, Scarica uno e adattarlo per i propri dati!

    Le linee guida precedenti sono state adattate da diverse fonti, tra cui:

    Best practice per la creazione di pubblicazioni di dati riutilizzabili. Driade. 2019. https://datadryad.org/stash/best_practices

    Formati di file. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/file-formats

    Introduzione ai diritti di proprietà intellettuale nella gestione dei dati. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/intellectual-property

    Metadati e dati descrittivi. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/writing-metadata