diff --git a/CHANGELOG.md b/CHANGELOG.md index 7fd9ad7cf..fef1bebcd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ - Refactor Upload to avoid validating the same contributors.tsv multiple times / running plugins over files multiple times - Add entry for segmentation-mask - Modify directory schema validation such that it takes empty directories into account - +- Add Publication next-gen directory schema ## v0.0.16 diff --git a/docs/publication/current/index.md b/docs/publication/current/index.md index 578491064..7d398c92a 100644 --- a/docs/publication/current/index.md +++ b/docs/publication/current/index.md @@ -28,6 +28,9 @@ Excel and TSV templates for this schema will be available when the draft next-ge | pattern | required? | description | | --- | --- | --- | -| TODO | ✓ | Directory structure not yet specified. | | extras\/.* | ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | +| data\/.+ (example: data/file1.ext) | ✓ | Supplementary data files for the publication. All files referenced by the Vitessce visualization configurations in the vignettes must be included in this directory. | +| vignettes\/.* | ✓ | Subdirectory containing Vitessce visualization files and a description of those files. | +| vignettes\/vignette_\d+\/[^\/]+\.json (example: vignettes/vignette_01/file1.json) | | Vitessce visualization configuration files. One or more visualization configurations can be provided per vignette. | +| vignettes\/vignette_\d+\/description\.md (example: vignettes/vignette_02/description.md) | | Description of the vignette and titles for the visualization configuration files. | diff --git a/src/ingest_validation_tools/directory-schemas/publication-v2.yaml b/src/ingest_validation_tools/directory-schemas/publication-v2.yaml index 3042b8779..d753a9d56 100644 --- a/src/ingest_validation_tools/directory-schemas/publication-v2.yaml +++ b/src/ingest_validation_tools/directory-schemas/publication-v2.yaml @@ -1,9 +1,24 @@ files: - - - pattern: 'TODO' - description: 'Directory structure not yet specified.' - required: True - pattern: extras\/.* required: True description: Folder for general lab-specific files related to the dataset. [Exists in all assays] + - + pattern: data\/.+ + required: True + description: Supplementary data files for the publication. All files referenced by the Vitessce visualization configurations in the vignettes must be included in this directory. + example: data/file1.ext + - + pattern: vignettes\/.* + required: True + description: Subdirectory containing Vitessce visualization files and a description of those files. + - + pattern: vignettes\/vignette_\d+\/[^\/]+\.json + required: False + description: Vitessce visualization configuration files. One or more visualization configurations can be provided per vignette. + example: vignettes/vignette_01/file1.json + - + pattern: vignettes\/vignette_\d+\/description\.md + required: False + description: Description of the vignette and titles for the visualization configuration files. + example: vignettes/vignette_02/description.md