Skip to content

Commit 1ac0ffd

Browse files
committed
README: explain using ngd as a method better
Signed-off-by: Kai Blin <[email protected]>
1 parent 3744cda commit 1ac0ffd

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -259,15 +259,20 @@ ncbi-genome-download --help
259259

260260
### As a method
261261

262-
You can also use it as a method call. Pass the pythonised keyword arguments
263-
(`_` instead of `-`) as described above or in the `--help`:
262+
You can also use it as a method call:
264263

265264
```python
266265
import ncbi_genome_download as ngd
267266
ngd.download()
268267
```
269268

270-
**Note**: To specify a taxonomic group, like _bacteria_, use the `group` keyword.
269+
Pass the pythonised keyword arguments as described above
270+
or in the `--help`. To specify taxonomic groups, like _bacteria_,
271+
use the `groups` keyword. To specify file formats, like for the `--format`
272+
CLI option, use `file_formats`. All other keywords should match the CLI
273+
options, with `-` converted to `_`. Note that because the method call
274+
follows the same logic as the CLI, lists data should still be passed as
275+
strings, separated by a comma but no spaces, just like on the command line.
271276

272277
### Contributed Scripts: `gimme_taxa.py`
273278

0 commit comments

Comments
 (0)