From 64264096c655838d7e67d139b28bf20fc3ab256c Mon Sep 17 00:00:00 2001 From: AlexVCaron Date: Thu, 11 Jan 2024 04:36:37 +0000 Subject: [PATCH] last fixes --- .github/workflows/test.yml | 2 +- README.md | 2 +- docs/MODULE.md | 7 ------- 3 files changed, 2 insertions(+), 9 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9343d9a7..3cd8f0b7 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Run tests +name: Modules Tests on: push: branches: [main] diff --git a/README.md b/README.md index 2acea97b..f8f82852 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/) [![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/) ![Code Linting](https://github.com/scilus/nf-scil/workflows/Code%20Linting/badge.svg) -![Modules Tests](https://github.com/scilus/nf-scil/workflows/Test%20All%20Modules/badge.svg) +![Modules Tests](https://github.com/scilus/nf-scil/workflows/Modules%20Tests/badge.svg) Welcome to `nf-scil` ! A **Nextflow** modules and workflows repository for neuroimaging maintained by the [SCIL team](https://scil-documentation.readthedocs.io/en/latest/). The diff --git a/docs/MODULE.md b/docs/MODULE.md index 2f4240e9..abcd911a 100644 --- a/docs/MODULE.md +++ b/docs/MODULE.md @@ -55,11 +55,9 @@ already follow all guidelines. You will find related files in : - Add your inputs in the `input:` section : - > [!NOTE] > Each line below `input:` defines an input channel for the process. A channel can > receive one (`val`, `path`, ...) or more (`tuple`) values per item. - > [!IMPORTANT] > When possible, add all optional input parameters (not data !) to `task.ext` instead of > listing them in the `input:` section (see [this section](#defining-processes-optional-parameters) > for more information). @@ -72,7 +70,6 @@ already follow all guidelines. You will find related files in : have to pass it an empty list `[]` for Nextflow to consider its value empty, but correct. - > [!IMPORTANT] > If you decide an input `path` value is optional, add `/* optional, value = [] */` > aside the parameter (e.g. f1 is optional, so `path(f1) /* optional, value = [] */` > or even `tuple val(meta), path(f1) /* optional, value = [] */, path(...` are valid @@ -86,7 +83,6 @@ already follow all guidelines. You will find related files in : The variable `optional_input1` is the one to use in the script. - > [!NOTE] > At its most simple, a variable is `usable` if its conversion to a string is valid > in the script (e.g. : if a variable can be empty or null, then its conversion to an > empty string must be valid in the sense of the script for the variable to be considered @@ -99,11 +95,9 @@ already follow all guidelines. You will find related files in : - File extensions MUST ALWAYS be defined (e.g. `path("*.{nii,nii.gz}")`). - > [!IMPORTANT] > Each line MUST use `emit: ` to make its results available inside Nextflow using > a relevant `name`. Results are accessible using : `PROCESS_NAME.out.`. - > [!NOTE] > Optional outputs ARE possible, add `, optional: true` after the `emit: ` clause. - Fill the `script` section : @@ -125,7 +119,6 @@ already follow all guidelines. You will find related files in : remove the lines in between the `cat` and the `END_VERSIONS` line. In it, add for each dependency a new line in the format : `: `. - > [!NOTE] > You can hard-bake the version as a number here, but if possible extract if from > the dependency dynamically. Refer to the `betcrop/fslbetcrop` module, in `main.nf` > for examples on how to extract the version number correctly.