Update README.md

README.md

@@ -28,7 +28,7 @@ configs:
     path: data/train-*
 ---
 
-# Dataset Card for OG: An Open Genomic Dataset
+# OG: An Open Genomic Dataset
 
 The OG dataset is a subset of the Open MetaGenomic dataset (OMG).   
 OG contains high quality prokaryotic and viral genomes with taxonomic information, and is roughly 10x smaller than OMG.  
@@ -54,6 +54,22 @@ ds = datasets.load_dataset('tattabio/OG', streaming=True)['train']
 print(next(iter(ds)))
 ```
 
+## Format
+
+Each row of the dataset represents a genomic scaffold, as an ordered list of amino acid coding sequences (CDS) and nucleotide intergenic sequences (IGS). 
+
+| Feature | Description | Example |
+|---|---|---|
+| `CDS_seqs` | A list of strings representing the amino acid CDS sequences. | `['MALTKVEKRNR...', 'MLGIDNIERVK...', 'MATIKVKQVR...', 'MNLSNIKPAS...']` |
+| `IGS_seqs` | A list of strings representing the nucleotide IGS sequences. | `['AATTTAAGGAA', 'TTTTAAAAGTATCGAAAT', 'TTTTTAAAGAAAA']` |
+| `CDS_position_ids` | A list of integers representing the position of each CDS element in the scaffold. | `[1, 3, 5, 6]` |
+| `IGS_position_ids` | A list of integers representing the position of each IGS element in the scaffold. | `[0, 2, 4]` |
+| `CDS_ids` | A list of string identifiers for each CDS element. | `['7000000126\|C1821366\|CDS\|gene_115413\|+\|84:437', '7000000126\|C1821366\|CDS\|gene_115414\|+\|456:977', '7000000126\|C1821366\|CDS\|gene_115415\|+\|991:1167', '7000000126\|C1821366\|CDS\|gene_115416\|+\|1168:1689']` |
+| `IGS_ids` | A list of string identifiers for each IGS element. | `['7000000126\|C1821366\|IG\|IG_000001\|+\|73:83', '7000000126\|C1821366\|IG\|IG_000002\|+\|438:455', '7000000126\|C1821366\|IG\|IG_000003\|+\|978:990']` |
+| `CDS_orientations` | A list of booleans indicating the orientation of each CDS. `True` represents the forward strand, and `False` represents the reverse strand. | `[True, True, True, False]` |
+
+
+ The format for the CDS and IGS id fields is: `sample_accession|contig_id|feature_type|gene_id|strand|start:end`
 
 
 ## Citation