-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
J uranic/publication nextgen dir schema (#1288)
* Update publication-v2.yaml Update to next-gen directory schema * Update CHANGELOG.md * Docs: Update publication directory schema --------- Co-authored-by: Juan Puerto <=> Co-authored-by: jpuerto-psc <[email protected]>
1 parent
8fd61e3
commit be9fe51
Showing
3 changed files
with
24 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 19 additions & 4 deletions
23
src/ingest_validation_tools/directory-schemas/publication-v2.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |