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

Add Nextflow schema #14

Merged
merged 7 commits into from
Aug 24, 2023
Merged
Changes from all commits
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
70 changes: 70 additions & 0 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/Sage-Bionetworks-Workflows/nf-artist/dsl2/nextflow_schema.json",
"title": "Sage-Bionetworks-Workflows/nf-artist parameters",
"description": "Nextflow pipeline for generating Minerva stories and Miniature thumbnails from multiplexed tissue imaging datasets",
"type": "object",
"definitions": {
"input_output_options": {
"title": "Input/output options",
"type": "object",
"fa_icon": "fas fa-terminal",
"description": "Define where the pipeline should find input data and save output data.",
"required": ["input", "outdir"],
"properties": {
"input": {
"type": "string",
"format": "file-path",
"mimetype": "text/csv",
"description": "Path to a CSV samplesheet"
},
"outdir": {
"type": "string",
"description": "Directory in which outputs are placed",
"default": "outputs"
}
}
},
"miniatue_options": {
"title": "Miniature options",
"type": "object",
"fa_icon": "fas fa-palette",
"description": "Define HTAN Artist pipeline parameters.",
"properties": {
"remove_bg": {
"type": "boolean",
"description": "Remove non-tissue background",
"default": true
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did we ever want to have the option to not remove background? (false)

Copy link
Collaborator Author

@adamjtaylor adamjtaylor Aug 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, when set to false the background is kept. Default is true as we expect this to be the case the majority of the time

},
"level": {
"type": "integer",
"description": "The pyramid level used in thumbnauls, Default: -1 (smallest)",
"default": -1
},
"dimred": {
"type": "string",
"description": "The dimensionality reduction method used",
"default": "umap",
"enum": ["umap", "tsne", "pca"]
},
"colormap": {
"type": "string",
"description": "The colormap used. Ensure colormap is compatiable with `n_components` selected ",
"enum": ["UCIE", "LAB", "RGB", "BREMM", "SCHUMANN", "STEIGER", "TEULING2", "ZIEGLER","CUBEDIAGONAL"],
"default": "UCIE"
},
"n_components": {
"type": "integer",
"description": "",
"default": 3,
"enum": [2,3]
}
}
}
},
"allOf": [
{
"$ref": "#/definitions/parameters"
}
]
}