Skip to content
Open
Show file tree
Hide file tree
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
6 changes: 4 additions & 2 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ params {

min_counts = 3
mutagenesis_type = 'nnk'
fitness = false
dimsum = false
run_seqdepth = false
reading_frame = null
custom_codon_library = '/NULL'
sliding_window_size = 10
aimed_cov = 100
fitness = false
dimsum = false

// Boilerplate options
outdir = null
Expand Down
20 changes: 15 additions & 5 deletions nextflow_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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)",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "To flatten graphs in plots (e.g. GLOBAL_POS_BIASES_COUNTS function)",
"description": "To flatten graphs in plots (e.g. `GLOBAL_POS_BIASES_COUNTS` function)",

you can use markdown syntax for the description

"default": 10
},
"aimed_cov": {
"type": "integer",
"description": "aimed coverage (assuming equal spread) to visualize threshold in plots",
"default": 100
Copy link
Contributor

Choose a reason for hiding this comment

The 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",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"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",
"description": "Type of mutagenic primers. Choose from nnk, nns, max_diff_to_wt, custom. When using 'custom', also provide the parameter 'custom_codon_library'.",

we usually show the default value in all the relevant places already.

Copy link
Contributor

Choose a reason for hiding this comment

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

using enums simplifies parameter validation

Suggested change
"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",
"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",
"enum": ["nnk", "nns", "max_diff_to_wt", "custom"],

"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'."
Copy link
Contributor

Choose a reason for hiding this comment

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

is a comma-separated .txt file, not a .csv file?

Suggested change
"description": "Path to a comma-separated .txt file listing custom codons (e.g., 'AAA,AAC,AAG,...'). Required when mutagenesis_type is set to '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`."

},
"dimsum": {
"type": "boolean",
"default": false,
"description": "Enable DiMSum execution."
"description": "Run DiMSum for fitness/functionality scores from grwoth-based selection input & output samples"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "Run DiMSum for fitness/functionality scores from grwoth-based selection input & output samples"
"description": "Run DiMSum for fitness/functionality scores from growth-based selection input & output samples"

},
"fitness": {
"type": "boolean",
Expand All @@ -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."
}
}
},
Expand Down
11 changes: 0 additions & 11 deletions workflows/deepmutscan.nf
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,6 @@ include { methodsDescriptionText } from '../subworkflows/local/utils_nfcore_deep
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/

// Params defaults
params.min_counts = 3 // minimum counts for variant to be recognized. All variants<min_counts will be set to 0
params.mutagenesis_type = 'nnk' // default library is set to nnk
params.custom_codon_library = '/NULL' // when mutagenesis_type is set to >>custom<< this variable has to be path to .txt with custom library
params.sliding_window_size = 10 // sliding window size to flatten graphs in plots (e.g. GLOBAL_POS_BIASES_COUNTS function)
params.aimed_cov = 100 // aimed coverage (assuming equal spread) to visualize threshold in plots
params.run_seqdepth = false // creating seqdepth simulation plot, is computationally quite heavy. per default disabled.
params.fitness = false // run basic fitness calculation from selection input & output samples
params.dimsum = false // run DiMSum for fitness/functionality scores from selection input & output samples


// Define fasta file as channel (e.g. for BWA index)
Channel
.fromPath(params.fasta, checkIfExists: true)
Expand Down
Loading