utils_nfschema_plugin

Run nf-schema to validate parameters and create a summary of changed parameters

validationJSON schemapluginparameterssummary

https://github.com/nf-core/modules/[...]/subworkflows/nf-core/utils_nfschema_plugin

Description

Run nf-schema to validate parameters and create a summary of changed parameters

Input

name

description

pattern

`input_workflow`

The workflow object of the used pipeline.
This object contains meta data used to create the params summary log

`validate_params`

Validate the parameters and error if invalid.

`parameters_schema`

Path to the parameters JSON schema.
This has to be the same as the schema given to the validation.parametersSchema config
option. When this input is empty it will automatically use the configured schema or
”${projectDir}/nextflow_schema.json” as default. The schema should not be given in this way
for meta pipelines.

`help`

Show the help message and exit. When a parameter name is given, show the help message for that parameter instead of the general help message.

`help_full`

Show the full help message and exit.

`show_hidden`

Show hidden parameters in the help message.

`before_text`

Text to show before the parameters summary and help message.

`after_text`

Text to show after the parameters summary and help message.

`command`

An example command to run the pipeline, to show in the help message and the summary.

`cli_typecast`

Whether to apply typecasting to the parameters given via the CLI before validation.
Set this to null to use the default behavior.

Output