search

biocompute-objects / BCO_Documentation

Repository for documentation to support the IEEE 2791-2020 standard. Please see our home page for communications/publications:
http://biocomputeobject.org/
BSD 3-Clause "New" or "Revised" License
16 stars 12 forks source link

Define keys of review object #16

Closed stain closed 6 years ago

stain commented 6 years ago

The review object is only shown by example.

The sub-keys reviewer_comment and reviewer must be further defined. For instance, why is reviewer_comment a list?

The possible values for status should be defined as a bullet-point list rather than inline in a text, so that is clear what are the only possible values.

corburn commented 6 years ago

@jpat1546 should _multi_value likewise be removed from reviewer:

https://github.com/biocompute-objects/BCO_Specification/blob/ef7f70f9b86f44fcd116c19d874112c6c055eccb/base_type_BioCompute.json#L73-L76

to match the example:

https://github.com/biocompute-objects/BCO_Specification/blame/ef7f70f9b86f44fcd116c19d874112c6c055eccb/provenance-domain.md#L74-L80

jpat1546 commented 6 years ago

For instance, why is reviewer_comment a list?

Fixed- it shouldn't be an array.

The possible values for status should be defined as a bullet-point list rather than inline in a text, so that is clear what are the only possible values.

Format changed.

HadleyKing commented 6 years ago

@corburn -

should _multi_value likewise be removed from reviewer:

BCO_Specification/base_type_BioCompute.json

Lines 73 to 76 in ef7f70f

"reviewer" : { "_type": "contributor", "_multi_value" : true }, to match the example:

https://github.com/biocompute-objects/BCO_Specification/blame/ef7f70f9b86f44fcd116c19d874112c6c055eccb/provenance-domain.md#L74-L80

Good catch! The review field should be the only _multi_value needed there.