Skip to content

Commit 4b5cafb

Browse files
authored
[SCHEMA] Add "directories" description for "study" DatasetType and add "docs" where was missing (#2185)
* Add "directories" description for "study" DatasetType and add "docs" where was missing Apparently I have missed this file entirely whenever I was preparing #1972 (study DatasetType) and also due to all the duplication we (I) missed that docs was not listed among "root.subdirs" or not listed at all. This would provide a fix, but I wonder if we could/should make it so we could avoid duplication altogether. As I have argued in #1972 I feel that "study" is the base dataset type and next ones just add potentially more to them. So may be we could come up with some more compact representation here... but not in this PR * Remove "phentoype/" and "stimuli/" from the "root" of the "study" dataset Since per se they should either be under "sourcedata/" or "derivatives/" one way or another even if it is some stimuli-only dataset(s)
1 parent 6bbd951 commit 4b5cafb

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

src/schema/rules/directories.yaml

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# This file defines layouts of directories.
2+
# This file defines layouts of directories for each DatasetType
33
#
44
# A layout defines a collection of directory specifiers.
55
# Each specifier has a naming convention, requirement level, opacity, and subdirectories.
@@ -16,10 +16,40 @@
1616
# The special "root" specifier describes the root of the dataset and only defines subdirectories.
1717
# No naming convention applies, and the requirement level and opacity would be superfluous.
1818
#
19+
study:
20+
root:
21+
subdirs:
22+
- code
23+
- docs
24+
- derivatives
25+
- logs
26+
- sourcedata
27+
code:
28+
name: code
29+
level: optional
30+
opaque: true
31+
docs:
32+
name: docs
33+
level: optional
34+
opaque: true
35+
derivatives:
36+
name: derivatives
37+
level: optional
38+
opaque: true
39+
logs:
40+
name: logs
41+
level: optional
42+
opaque: true
43+
sourcedata:
44+
name: sourcedata
45+
level: optional
46+
opaque: true
47+
1948
raw:
2049
root:
2150
subdirs:
2251
- code
52+
- docs
2353
- derivatives
2454
- logs
2555
- phenotype
@@ -77,6 +107,7 @@ derivative:
77107
root:
78108
subdirs:
79109
- code
110+
- docs
80111
- derivatives
81112
- logs
82113
- phenotype
@@ -87,6 +118,10 @@ derivative:
87118
name: code
88119
level: optional
89120
opaque: true
121+
docs:
122+
name: docs
123+
level: optional
124+
opaque: true
90125
derivatives:
91126
name: derivatives
92127
level: optional

0 commit comments

Comments
 (0)