Regole metadati e zip
In questa sezione della guida vengono descritte le caratteristiche che devono avere i files e i metadati usati per l'upload, assieme alle regole che essi devono rispettare perchè la loro validazione venga eseguita con successo.
Metadati
Si invita a consultare il glossario dei metadati per una trattazione specifica sui singoli campi presenti nei modelli dei metadati.
Metadati aggiunti da form
Se i metadati vengono aggiunti manualmente tramite l'opzione Aggiungi da form, o se le schede di uno o più campioni vengono modificate manualmente, l'utente viene guidato nella selezione dei valori dei metadati. Ci sono quindi solo 2 regole da seguire, per garantire una corretta validazione della scheda dei metadati:
- Usare un Codice (nome del file) corretto;
- Compilare almeno i campi obbligatori per i metadati.
Usare un Codice
Il testo da inserire nel campo "Codice" è il nome del file fasta o fastq che si intende caricare.
- Il codice è costituito dal nome del file, senza estensione, che si trova nell'archivio zip che viene caricato;
- Il codice e il nome del file non devono contenere spazi;
- Nel caso di files fastq di reads paired-end, il codice non deve contenere l'identificatore della read forward o reverse (ad esempio "_R1" o "_1") e deve essere unico (la scheda dei metadati vale infatti per entrambe le reads).
Nota Il modello dei metadati offre anche la possibilità di specificare i nomi completi dei files (entrambe le reads per i files paired-end, unico per reads single-end o fasta). Nel caso tali colonne siano riempite, il controllo verrà effettuato sui nomi completi dei files, piuttosto che sul solo codice.
Compilare i campi obbligatori
I campi obbligatori possono variare in base alla tipologia di campione che viene caricato; ad esempio, un campione di ricerca avrà meno campi obbligatori rispetto ad un campione ufficiale, per il quale è invece necessario fornire un maggior numero di metadati.
In generale, i metadati minimi obbligatori possono richiedere di:
- riempire il campo
code; - specificare la tipologia di campione (ufficiale, ricerca, etc.), il tipo di file (fasta o fastq) e, in caso di fastq, la tecnologia dell'apparato per il sequenziamento (Illumina paired-end, Nanopore single-end, etc.);
- indicare la specie o il materiale.
In fase di validazione vengono evidenziati con dei messaggi di errore i campi obligatori con valori assenti o errati.
TIP Inserendo i metadati da form o utilizzando le funzioni di edit della piattaforma, campi come specie o materiale, possono essere valorizzati tramite un menu a tendina o una specifica tabella. In questi casi la scelta è guidata e garantisce l'inserimento del codice corretto.
Metadati aggiunti tramite file
I templati dei files tabulari per la sottomissione dei metadati sono scaricabili direttamente dalla sezione Modelli di files dei metadati della pagina di questo wiki dedicata all'Upload. I modelli sono disponibili sia in formato .tsv che in formato .xls.
TIP I template sono scaricabili anche dalla piattaforma sia tramite la modale di caricamento dei metadati (bottone
Aggiungi da file) che da menu contestualedella pagina di upload.
Metadati richiesti
Ogni colonna del file dei metadati corrisponde ad un campo della scheda metadati.
Nel template del file dei metadati, la seconda riga funge da esempio per quanto riguarda la formattazione e il tipo di testo da inserire in ogni cella.
Valgono le seguenti indicazioni per i campi dei metadati richiesti dal template:
- Il campo
metadata_typepuò assumere i seguenti valori:official- (upload di campioni ufficiali);research- (campioni caricati a scopo di ricerca).
Ogni profilo utente può effettuare upload di tipi specifici tra quelli sopra elencati e il sistema non accetterà upload di tipi diversi da quelli consentiti. Alcuni metadati, inoltre, sono obbligatori solo se l'upload è di campioni ufficiali (
metadata_type=official).
- I campi di
species,material,host,matrixesampling_pointnon vanno riempiti con nomi tassonomici o descrizioni testuali, ma con il codice corrispondente nelle tabelle della piattaforma.
TIP Le tabelle dei codici dei metadati sono consultabili in
Elementi principali > Metadatidel menù laterale della piattaforma. Ulteriori informazioni sono disponibili nella sezione Metadati di questa Wiki.
- Il campo
read_formatpuò assumere i valori: fasta;illumina_paired(files fastq paired-end da apparati Illumina);ion(file fastq single-end da apparato Iontorrent);nanopore(file fastq single-end da apparato Nanopore).
Per tutte le altre indicazioni e restrizioni, valgono le informazioni fornite nella sezione Metadati aggiunti da form - Campi obbligatori e nel glossario dei metadati.
Files delle sequenze
I files in formato fasta vengono riconosciuti se possiedono estensione .fasta o .fa. Analogamente, i files in formato fastq vengono riconosciuti se possiedono estensione .fastq.gz o .fq.gz.
Nota: La compressione dei files fastq in formato
.gzè obbligatoria. I files fasta vengono invece accettati con e senza estensione.gz.
Archivio zip
L'archivio deve essere in formato .zip. In fase di caricamento, il sistema opererà un controllo delle schede dei metadati, che vengono associati ai campioni corrispondenti. Affinchè la procedura di upload vada a buon fine, è necessario che il nome di ogni file fasta o fastq (esclusa l'estensione del file) corrisponda al valore del metadato code inseriso durante il caricamento dei metadati.
Se almeno uno o solo alcuni dei campioni nell'archivio zip presentano corrispondenze con i codici nelle schede validate, il processo di upload verrà portato a termine solo per quei file e con delle avvertenze.
Nel caso in cui l'archivio zip contenga dei files i cui nomi non corrispondono a nessuno dei codici insriti nelle schede dei metadati validate, la richiesta di upload produrrà un fallimento.
TIP I files nell'archivio possono trovarsi anche all'interno di un sistema di cartelle e sotto-cartelle, purché la struttura non superi i 10 livelli di profondità.