ODM2 / YODA-File

The YAML Observation Data Archive & exchange (YODA) File Format
BSD 3-Clause "New" or "Revised" License
4 stars 0 forks source link

Additional info in yoda header? #4

Closed valentinedwv closed 9 years ago

valentinedwv commented 9 years ago

Present

YODA:

- {Version: 1.0.0, Profile: TimeSeries}

propose

YODA:

horsburgh commented 9 years ago

Good ideas. If we want to use a reference to a person in this block (the contact person), the reference couldn't come before the definition of the anchor for the person (YAML parsers don't allow this). I think it would be good to keep the YODA block as the very first block in every YODA file. Should we just expand the contact person details in the YODA block? This would be the contact information for the person responsible for the YODA file and not necessarily the people associated with the data.

SRGDamia1 commented 9 years ago

What exactly would the "dataCreated" and "datafileUpdated" fields be for?

valentinedwv commented 9 years ago

These are stored on disk. So when this file was first created. And when it was last updated

Sent from my iPhone

On Mar 9, 2015, at 9:52 AM, Sara Damiano notifications@github.com wrote:

What exactly would the "dataCreated" and "datafileUpdated" fields be for?

— Reply to this email directly or view it on GitHub.

SRGDamia1 commented 9 years ago

If it's for the date when the datafile was created then we should say "datafileCreated" not "dataCreated."

horsburgh commented 9 years ago

Or just dateCreated and dateUpdated.

SRGDamia1 commented 9 years ago

Do we also want to include information about the tool used to produce the YAML?

valentinedwv commented 9 years ago

That sounds like a good idea. Tool: name, version

On Fri, Mar 13, 2015 at 10:06 AM, Sara Damiano notifications@github.com wrote:

Do we also want to include information about the tool used to produce the YAML?

— Reply to this email directly or view it on GitHub https://github.com/CZOData/YODA-File/issues/4#issuecomment-79140209.

emiliom commented 9 years ago

Do we also want to include information about the tool used to produce the YAML?

That can often be very useful information. You might want to think about where that information would go when loading into an ODM2 database instance. Could be simply text that's part of Actions.ActionDescription in a YODA data-loading action. Or Methods.MethodDescription, if data loading from a YODA file has been discussed as being a specific "method".

SRGDamia1 commented 9 years ago

So this is the current header I'm putting in the excel template:

YODA: {YODAVersion: “1.0.0”, Profile: “TimeSeries”, CreationTool: “Excel Template v1.0”, DateCreated: "2015-03-13", DateUpdated: "2015-03-13"}

horsburgh commented 9 years ago

For consistency with the other blocks, do it this way:

YODA:

Are we enclosing everything in quotation marks?

SRGDamia1 commented 9 years ago

Changed.

And I have been putting quotes around all text and date fields even though it's not strictly necessary. The online parser I was testing against kept failing, especially with dates, so I decided it was safer to just put them in everywhere.

horsburgh commented 9 years ago

I put this additional information in the YODA block of the iUTAH examples. I think the "YODAVersion" element should just be "Version". It's within the YODA block, so "YODAVersion" is redundant.

I'm going to create a separate issue about how much of the text in the YODA files we want to enclose in quotations.