Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Cunliang Geng <c.geng@esciencecenter.nl>
  • Loading branch information
adraismawur and CunliangGeng authored Jul 17, 2024
1 parent 5cadd45 commit 1efc8fd
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/nplinker/genomics/bigscape/runbigscape.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ def run_bigscape(
The directory can contain subdirectories, in which case BiG-SCAPE will search
recursively for GBK files. E.g.:
```
example_folder
├── organism_1
│  ├── organism_1.region001.gbk
Expand All @@ -38,6 +39,7 @@ def run_bigscape(
├── organism_2
│  ├── ...
└── ...
```
By default, only GBK Files with "cluster" or "region" in the filename are
accepted. GBK Files with "final" in the filename are excluded.
Expand All @@ -56,6 +58,10 @@ def run_bigscape(
FileNotFoundError: If the antismash_path does not exist or if the BiG-SCAPE python
script could not be found.
RuntimeError: If BiG-SCAPE fails to run.
Examples:
>>> from nplinker.genomics.bigscape import run_bigscape
>>> run_bigscape(antismash_path="./antismash", output_path="./output",
... extra_params="--help", version=1)
"""
# switch to correct version of BiG-SCAPE
if version == 1:
Expand Down

0 comments on commit 1efc8fd

Please sign in to comment.