Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nvnieuwk committed Aug 20, 2024
1 parent 8e47c56 commit 15f2f39
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,10 @@ Any string provided to this option will printed before the help message.
validation.help.beforeText = "Running pipeline version 1.0" // default: ""
```

!!! info

All color values (like `\033[0;31m`, which means the color red) will be filtered out when `validation.monochromeLogs` is set to `true`

### command

!!! example "This option does not affect the help message created by the `paramsHelp()` function"
Expand All @@ -166,6 +170,10 @@ Typical pipeline command:
nextflow run main.nf --input samplesheet.csv --outdir output
```

!!! info

All color values (like `\033[0;31m`, which means the color red) will be filtered out when `validation.monochromeLogs` is set to `true`

### afterText

!!! example "This option does not affect the help message created by the `paramsHelp()` function"
Expand All @@ -175,3 +183,37 @@ Any string provided to this option will be printed after the help message.
```groovy
validation.help.afterText = "Please cite the pipeline owners when using this pipeline" // default: ""
```

!!! info

All color values (like `\033[0;31m`, which means the color red) will be filtered out when `validation.monochromeLogs` is set to `true`

## Summary

The `validation.summary` config scope can be used to configure the output of the `paramsSummaryLog()` function.

This scope contains the following options:

### beforeText

Any string provided to this option will printed before the parameters log message.

```groovy
validation.summary.beforeText = "Running pipeline version 1.0" // default: ""
```

!!! info

All color values (like `\033[0;31m`, which means the color red) will be filtered out when `validation.monochromeLogs` is set to `true`

### afterText

Any string provided to this option will be printed after the parameters log message.

```groovy
validation.summary.afterText = "Please cite the pipeline owners when using this pipeline" // default: ""
```

!!! info

All color values (like `\033[0;31m`, which means the color red) will be filtered out when `validation.monochromeLogs` is set to `true`

0 comments on commit 15f2f39

Please sign in to comment.