-
Notifications
You must be signed in to change notification settings - Fork 3
transfer parameter definitions from deepmutscan.nf to nextflow.config #18
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
base: dev
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -48,24 +48,34 @@ | |||||||||||
| }, | ||||||||||||
| "min_counts": { | ||||||||||||
| "type": "integer", | ||||||||||||
| "description": "Minimum number of variant observations required.", | ||||||||||||
| "description": "minimum counts for variant to be recognized. All variants below min_counts will be set to 0", | ||||||||||||
| "minimum": 1, | ||||||||||||
| "default": 3 | ||||||||||||
| }, | ||||||||||||
| "sliding_window_size": { | ||||||||||||
| "type": "integer", | ||||||||||||
| "description": "To flatten graphs in plots (e.g. GLOBAL_POS_BIASES_COUNTS function)", | ||||||||||||
| "default": 10 | ||||||||||||
| }, | ||||||||||||
| "aimed_cov": { | ||||||||||||
| "type": "integer", | ||||||||||||
| "description": "aimed coverage (assuming equal spread) to visualize threshold in plots", | ||||||||||||
| "default": 100 | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. one can set minimum and maximum values in json schema: https://json-schema.org/understanding-json-schema/reference/numeric#range , to help with some parameter validation |
||||||||||||
| }, | ||||||||||||
| "mutagenesis_type": { | ||||||||||||
| "type": "string", | ||||||||||||
| "description": "Type of mutagenic primers. Choose from nnk, nns, max_diff_to_wt, custom. When using 'custom', also provide the parameter 'custom_codon_library'", | ||||||||||||
| "description": "Type of mutagenic primers. Choose from nnk, nns, max_diff_to_wt, custom. When using 'custom', also provide the parameter 'custom_codon_library'. Default library is set to nnk", | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
we usually show the default value in all the relevant places already.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. using enums simplifies parameter validation
Suggested change
|
||||||||||||
| "default": "nnk" | ||||||||||||
| }, | ||||||||||||
| "custom_codon_library": { | ||||||||||||
| "type": "string", | ||||||||||||
| "format": "file-path", | ||||||||||||
| "description": "Path to a comma-separated .txt file listing custom codons (e.g., 'AAA,AAC,AAG,...'). Required when mutagenesis_type is 'custom'." | ||||||||||||
| "description": "Path to a comma-separated .txt file listing custom codons (e.g., 'AAA,AAC,AAG,...'). Required when mutagenesis_type is set to 'custom'." | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is a comma-separated .txt file, not a
Suggested change
|
||||||||||||
| }, | ||||||||||||
| "dimsum": { | ||||||||||||
| "type": "boolean", | ||||||||||||
| "default": false, | ||||||||||||
| "description": "Enable DiMSum execution." | ||||||||||||
| "description": "Run DiMSum for fitness/functionality scores from grwoth-based selection input & output samples" | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
| }, | ||||||||||||
| "fitness": { | ||||||||||||
| "type": "boolean", | ||||||||||||
|
|
@@ -75,7 +85,7 @@ | |||||||||||
| "run_seqdepth": { | ||||||||||||
| "type": "boolean", | ||||||||||||
| "default": false, | ||||||||||||
| "description": "Whether to run the SeqDepth simulation module. This is computationally intensive and optional." | ||||||||||||
| "description": "Whether to run the SeqDepth simulation module, to check on the sequencing depth. This is computationally intensive and optional." | ||||||||||||
| } | ||||||||||||
| } | ||||||||||||
| }, | ||||||||||||
|
|
||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can use markdown syntax for the description