Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] Formalize presence of optional logs/ folder #1962

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,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 could be stored under `logs/` subdirectory.
yarikoptic marked this conversation as resolved.
Show resolved Hide resolved

Example of a derivative dataset including the raw dataset as source:

Expand Down
10 changes: 10 additions & 0 deletions src/schema/rules/directories.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ raw:
subdirs:
- code
- derivatives
- logs
- phenotype
- sourcedata
- stimuli
Expand All @@ -33,6 +34,10 @@ raw:
name: derivatives
level: optional
opaque: true
logs:
name: logs
level: optional
opaque: true
phenotype:
name: phenotype
level: optional
Expand Down Expand Up @@ -69,6 +74,7 @@ derivative:
subdirs:
- code
- derivatives
- logs
- phenotype
- sourcedata
- stimuli
Expand All @@ -81,6 +87,10 @@ derivative:
name: derivatives
level: optional
opaque: true
logs:
name: logs
level: optional
opaque: true
phenotype:
name: phenotype
level: optional
Expand Down
3 changes: 3 additions & 0 deletions src/schema/rules/files/common/core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ code:
derivatives:
level: optional
path: derivatives
logs:
level: optional
path: logs
sourcedata:
level: optional
path: sourcedata
Expand Down