Skip to content

Commit

Permalink
update readme [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
abhi18av committed Jul 31, 2023
1 parent 9c72fc5 commit c46fd86
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,39 +15,30 @@ nextflow run https://github.com/nf-modules-hub/tb-profiler

## Options


- `collate`

For collating the individual results obtained by running `tb-profiler` you can set pass this option.

```
nextflow run https://github.com/nf-modules-hub/tb-profiler --collate
```

- `filePattern`
- `file_pattern`

By default, the process assumes the files to follow the `*_{R1,R2}.fastq.gz` pattern, which could be customized using this option

```
nextflow run https://github.com/nf-modules-hub/tb-profiler --filePattern './*_{1,2}.fastq.gz'
nextflow run https://github.com/nf-modules-hub/tb-profiler --file_pattern './*_{1,2}.fastq.gz'
```

- `resultsDir`
- `outdir`

By default, it stores the result files locally inside the `results` directory.

```
nextflow run https://github.com/nf-modules-hub/tb-profiler --resultsDir /path/to/custom/resultsDir
nextflow run https://github.com/nf-modules-hub/tb-profiler --outdir /path/to/custom/resultsDir
```

- `saveMode`
- `publish_dir_mode`

By default, the pipeline publishes the results in the `resultsDir` by copying the relevant output.
By default, the pipeline publishes the results in the `outdir` by copying the relevant output.

You can update this behavior by simply specifying the alternative such as `move` or `link` etc.

```
nextflow run https://github.com/nf-modules-hub/tb-profiler --saveMode move
nextflow run https://github.com/nf-modules-hub/tb-profiler --publish_dir_mode move
```

For more information please refer [Nextflow documentation](https://www.nextflow.io/docs/latest/process.html#publishdir)
Expand Down

0 comments on commit c46fd86

Please sign in to comment.