Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Formatting
  • Loading branch information
aufdenkampe authored Nov 10, 2017
1 parent 3b0b142 commit 3df181b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ We developed the **YAML Observation Data Archive & Exchange (YODA) File Format**
### Design Vision
A YODA File follows the data serialization and interchange format of [YAML](http://en.wikipedia.org/wiki/YAML) ("YAML Ain't Markup Language"), a superset of [JSON](http://www.json.org/) (JavaScript Object Notation). YAML can be readily [parsed by any modern computer language](http://yaml.org/).

The key feature of a YODA file that distiguishes it from generic YAML is that a YODA file (1) organizes data into a comma-separated data array (e.g. a data table or DataFrame) with multiple columns and rows, and (2) provides all the metadata of an [ODM2](https://github.com/ODM2/ODM2) [Dataset](https://github.com/ODM2/ODM2/blob/master/doc/ODM2Docs/core_datasets.md) so that the data array can be parsed by software into an [ODM2](https://github.com/ODM2/ODM2) database instance.
The key feature of a YODA file that distiguishes it from generic YAML is that a YODA file:
1. Organizes data into a comma-separated data array (e.g. a data table or DataFrame) with multiple columns and rows, and
2. Provides all the metadata of an [ODM2](https://github.com/ODM2/ODM2) [Dataset](https://github.com/ODM2/ODM2/blob/master/doc/ODM2Docs/core_datasets.md) so that the data array can be parsed by software into an [ODM2](https://github.com/ODM2/ODM2) database instance.

[YODA Profiles](https://github.com/ODM2/YODA-File/blob/master/doc/YODA_profiles.md#yoda-profiles) have been developed for common dataset types to define expectations for the data array block and to facilitate data/metadata input forms/templates for the end-user.

Expand Down

0 comments on commit 3df181b

Please sign in to comment.