Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the specification of the
Datamap
(Former Working nameDataset
) to the ARC-specification. The main idea behind theDatamap
is to give additional context and explanations about the data entities defined in an assay or a study. To keep this streamlined, it also makes use of referencing the data entities of interest using theData fragment selector
principle. The motivation behind this additional context is to allow for a more static description of the data entities besides referencing them out of the processes defined in annotationTables. This will add a lot more flexibility to power users on the one hand, and an easier point of access for new users on the other hand.I propose the
Datamap
as an extension only in the ISA-XLSX specification here, as the extension of the ISA abstract model was not accepted: ISA-tools/isa-specs#15The extension adds three parts:
Datamap table sheet
format containing details about the different columns (ISA-XLSX.md)Datamap file
format (ISA-XLSX.md)Datamap file
in theStudy
andAssay
section of the (ARC-specification.md)I dropped the name
Dataset
, as this is already being occupied by theDataset
type in Schema.org, which is a first-class citizen in RO-Crate. The alternative nameDatamap
is debatable. I chose it overDataDictionary
because it's much shorter but covers roughly the same semantic principle. Also,DataContext
might be a fitting alternative. Furthermore, we might change typing toDataMap
.Input would be very welcome, @kappe-c @floWetzels @ZimmerD @kMutagene @Freymaurer @chgarth @muehlhaus @gdoniparthi
closes #80
closes #82