Metadata YAML Template - GerkeLab/curatedProstateData GitHub Wiki

This example YAML section can be used as a template when formatting the YAML for tracking metadata for a given data set.

label: Name for Internal Reference
title: Long Title of the Data Set or Accompanying Paper
accession: GSE0000
year: 2001
pubmed_id: [100001, 100002, 100003]
doi: 10.1000/pnas.0000000000
platform:
  - name: Platform Name or Title
    summary: A summary of the platform process
    manufacturer: Manufacturer Name
    distribution: non-commercial
    accession: GPL0000
    technology: spotted DNA/cDNA
  - name: Platform Name or Title
    manufacturer: Manufacturer Name
    distribution: commercial
    accession: GPL0000
    technology: in situ oligonucleotide
citation: >
  Author A, Author B, Author C, et al.
  Article Title.
  Journal Title USA 2006 Jan 02;101(3):811-6.
size:
  'n': 62
  comments: notes about size, n above is the most salient size
link:
  primary: link-to-primary-source
  pub: link-to-primary-publication
  data: direct-link-to-download-data
  website: link-to-author-or-group-website
comments: General comments, warnings, or notes about this source

All of the above are currently optional fields except for label.

A useful YAML validator