Merge pull request #1962 from yarikoptic/enh-logs

[ENH] Formalize presence of optional logs/ folder

Author: effigies

src/common-principles.md

@@ -392,6 +392,7 @@ Derivatives can be stored/distributed in two ways:
     that were used to generate the derivatives.
     Likewise, any code used to generate the derivatives from the source data
     MAY be included in the `code/` subdirectory.
+    Logs from running the code or other commands MAY be stored under `logs/` subdirectory.
 
     Example of a derivative dataset including the raw dataset as source:
 

src/schema/rules/directories.yaml

@@ -21,6 +21,7 @@ raw:
     subdirs:
       - code
       - derivatives
+      - logs
       - phenotype
       - sourcedata
       - stimuli
@@ -33,6 +34,10 @@ raw:
     name: derivatives
     level: optional
     opaque: true
+  logs:
+    name: logs
+    level: optional
+    opaque: true
   phenotype:
     name: phenotype
     level: optional
@@ -69,6 +74,7 @@ derivative:
     subdirs:
       - code
       - derivatives
+      - logs
       - phenotype
       - sourcedata
       - stimuli
@@ -81,6 +87,10 @@ derivative:
     name: derivatives
     level: optional
     opaque: true
+  logs:
+    name: logs
+    level: optional
+    opaque: true
   phenotype:
     name: phenotype
     level: optional

src/schema/rules/files/common/core.yaml

@@ -36,6 +36,9 @@ code:
 derivatives:
   level: optional
   path: derivatives
+logs:
+  level: optional
+  path: logs
 sourcedata:
   level: optional
   path: sourcedata