Skip to content

Commit

Permalink
expand docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
adraismawur committed Jul 17, 2024
1 parent 69f7674 commit 5cadd45
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/nplinker/genomics/bigscape/runbigscape.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,18 @@ def run_bigscape(
The AntiSMASH output directory should be a directory that contains GBK files.
The directory can contain subdirectories, in which case BiG-SCAPE will search
recursively for GBK files.
recursively for GBK files. E.g.:
example_folder
├── organism_1
│  ├── organism_1.region001.gbk
│  ├── organism_1.region002.gbk
│  ├── organism_1.region003.gbk
│  ├── organism_1.final.gbk <- skipped!
│  └── ...
├── 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 Down

0 comments on commit 5cadd45

Please sign in to comment.