Skip to content

Commit

Permalink
Document branch selection and resource usage
Browse files Browse the repository at this point in the history
  • Loading branch information
charles-plessy committed Oct 31, 2024
1 parent 8d7d144 commit 8fc57fd
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,27 @@ genome1 /path/to/genome/file.fastq.gz
Now, you can run the pipeline using:

```bash
nextflow run oist/LuscombeU_stlpreprocess \
nextflow run oist/LuscombeU_stlpreprocess -r master \
-profile <docker/singularity/.../institute> \
--input samplesheet.tsv \
--outdir <OUTDIR>
```

The `-r master` option selects the branch or version of the pipeline. Alternatives are `-r dev` for the latest version in development or version numbers such as `-r 3.0.0` for instance.

> [!WARNING]
> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
> see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
## Resource usage

- On annelids, `assembly-scan` took a maximum of 2 GB memory. Filtering is now very lean, using less than 300 MB. All tasks completed in less than 40 min.

Use the `--assemblyscan_memory` parameter to give more memory to `assembly-scan`. The
default is `6.GB`. If not all the genomes are big, let the pipeline first
process the small ones with default parameters, and then run it again with
`-resume` and `--assemblyscan_memory`.

## Credits

oist/LuscombeU_stlpreprocess was originally written by @charles-plessy.
Expand Down

0 comments on commit 8fc57fd

Please sign in to comment.