Skip to content

Commit

Permalink
Update usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mahesh-panchal committed May 28, 2024
1 parent f45a595 commit ccbe7ea
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions subworkflows/functional_annotation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,16 @@ genome: '/path/to/genome/assembly.fasta'
gff_annotation: '/path/to/annotation.gff3'
blast_db_fasta: '/path/to/protein/database.fasta'
outdir: '/path/to/save/results'
db_cache: '/path/to/save/interproscan_db/'
```
> [!IMPORTANT]
> The Interproscan database is huge. If you supply `db_cache` then it will be downloaded
> once and saved in that directory. Setting your `db_cache` to this path for every run
> will then reuse this folder to supply the Interproscan database without re-extracting it again.
>
> Alternatively, set `interproscan_database` to point to the local path of the interproscan database.

Command line:

```bash
Expand All @@ -37,6 +45,9 @@ nextflow run NBISweden/pipelines-nextflow \
- `blast_db_fasta` : Path to blast protein database fasta.
- `merge_annotation_identifier`: The identifier to use for labeling genes (default: NBIS).
- `use_pcds`: If true, enables the pcds flag when merging annotation.
- `interproscan_database`: Path to interproscan database, if this is a `tar.gz`, the file will be extracted under
`db_cache` and saved for future use.
- `db_cahce`: The path to save the untarred Interproscan database archive.

### Tool specific parameters

Expand Down

0 comments on commit ccbe7ea

Please sign in to comment.