Skip to main content

bactopia-search

Query against ENA and SRA for public accessions to process with Bactopia

Usage

bactopia-search [OPTIONS]

Required Options

OptionTypeDefaultDescription
--query, -qSTRINGTaxon ID or Study, BioSample, or Run accession (can also be comma separated or a file of accessions)

Query Options

OptionTypeDefaultDescription
--exact-taxonBOOLfalseExclude Taxon ID descendants
--limit, -lINT1000000Maximum number of results (per query) to return
--accession-limit, -alINT5000Maximum number of accessions to query at once
--biosample-subsetINT0If a BioSample has multiple Experiments, maximum number to randomly select (0 = disabled)
--include-emptyBOOLfalseInclude metadata columns that are empty for all rows

Filtering Options

OptionTypeDefaultDescription
--min-base-count, -mbcINT0Filters samples based on minimum base pair count (0 = disabled)
--min-read-length, -mrlINT0Filters samples based on minimum mean read length (0 = disabled)
--min-coverage, -mcINT0Filter samples based on minimum coverage (requires --genome_size, 0 = disabled)

Additional Options

OptionTypeDefaultDescription
--genome-size, -gsizeINT0Genome size to be used for all samples, and for calculating min coverage
--use-ncbi-genome-sizeBOOLfalseIf available, use NCBI genome size for species
--outdir, -oSTRING./Directory to write output
--prefix, -pSTRINGbactopiaPrefix to use for output file names
--forceBOOLfalseOverwrite existing reports
--verboseBOOLfalsePrint debug related text
--silentBOOLfalseOnly critical errors will be printed
--version, -VBOOLfalseShow the version and exit.