From 1ac0ffdbba877d66545ba2cd8f5effb5abe94b04 Mon Sep 17 00:00:00 2001 From: Kai Blin Date: Mon, 5 Aug 2024 15:04:31 +0200 Subject: [PATCH] README: explain using ngd as a method better Signed-off-by: Kai Blin --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index da608fa..de902ba 100644 --- a/README.md +++ b/README.md @@ -259,15 +259,20 @@ ncbi-genome-download --help ### As a method -You can also use it as a method call. Pass the pythonised keyword arguments -(`_` instead of `-`) as described above or in the `--help`: +You can also use it as a method call: ```python import ncbi_genome_download as ngd ngd.download() ``` -**Note**: To specify a taxonomic group, like _bacteria_, use the `group` keyword. +Pass the pythonised keyword arguments as described above +or in the `--help`. To specify taxonomic groups, like _bacteria_, +use the `groups` keyword. To specify file formats, like for the `--format` +CLI option, use `file_formats`. All other keywords should match the CLI +options, with `-` converted to `_`. Note that because the method call +follows the same logic as the CLI, lists data should still be passed as +strings, separated by a comma but no spaces, just like on the command line. ### Contributed Scripts: `gimme_taxa.py`