Skip to content

Commit 5da2338

Browse files
committed
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
1 parent 6bbd951 commit 5da2338

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

src/schema/rules/directories.yaml

Lines changed: 46 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,50 @@
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+
- phenotype
27+
- sourcedata
28+
- stimuli
29+
code:
30+
name: code
31+
level: optional
32+
opaque: true
33+
docs:
34+
name: docs
35+
level: optional
36+
opaque: true
37+
derivatives:
38+
name: derivatives
39+
level: optional
40+
opaque: true
41+
logs:
42+
name: logs
43+
level: optional
44+
opaque: true
45+
phenotype:
46+
name: phenotype
47+
level: optional
48+
opaque: false
49+
sourcedata:
50+
name: sourcedata
51+
level: optional
52+
opaque: true
53+
stimuli:
54+
name: stimuli
55+
level: optional
56+
opaque: true
57+
1958
raw:
2059
root:
2160
subdirs:
2261
- code
62+
- docs
2363
- derivatives
2464
- logs
2565
- phenotype
@@ -77,6 +117,7 @@ derivative:
77117
root:
78118
subdirs:
79119
- code
120+
- docs
80121
- derivatives
81122
- logs
82123
- phenotype
@@ -87,6 +128,10 @@ derivative:
87128
name: code
88129
level: optional
89130
opaque: true
131+
docs:
132+
name: docs
133+
level: optional
134+
opaque: true
90135
derivatives:
91136
name: derivatives
92137
level: optional

0 commit comments

Comments
 (0)