We must clarify in the spec how to easily identify a BagIt bag as an ERC

o2r-project / erc-spec

Executable Research Compendium specification and guides

https://o2r.info/erc-spec/

Creative Commons Zero v1.0 Universal

7 stars 5 forks source link

We must clarify in the spec how to easily identify a BagIt bag as an ERC #42

Closed nuest closed 6 years ago

nuest commented 6 years ago

Ideas (not necessarily conflicting):

"open bag, look for data/erc.yml, if it exists, it's an ERC
use mime type?
use bag metadata, add field Executable-Research-Compendium: Yes to bag-info.txt

ghost commented 6 years ago

open bag, look for data/erc.yml, get id, if it exists, it's an ERC
mime type of which file(s)?
bag-info.txt: Is-Executable-Research-Compendium: True -> that would be the outer most place to mark the ERC. I think, I would prefer that.

nuest commented 6 years ago

:+1: on the "get id" part in erc.yml.

Then suggest to got with

a) the bag-info.txt for identification (I also like it because implementations can simply grep that out of a plain text file), and also b) the there is an id in erc.yml as part of the checking process but not for identification (besides erc.yml being well-formed)

ghost commented 6 years ago

bag-info.txt is an optional file. The bagit.txt is required and is also the file that stores the version information of the bag. That one is what we want.

nuest commented 6 years ago

[x] mention in the spec that implementations should use this approach