Page:
usage query
Pages
Home
architecture
formats index_layout
installation
theory encoding
theory entropy_filter
theory indexing_architecture
theory kmer_indexing encoding
theory kmer_indexing entropy_filter
theory kmer_indexing indexing_architecture
theory kmer_indexing kmers
theory kmer_indexing minimizer_selection
theory kmer_indexing superkmers
theory kmers_and_superkmers
theory minimizer_selection
theory phylogeny kmer_based distance_metrics
theory phylogeny kmer_based kmer_set_distances
theory phylogeny snp_based central_snp_model
theory phylogeny snp_based gamma_rate_heterogeneity
theory phylogeny snp_based sampling_design
theory phylogeny snp_based sankoff_model
usage annotate
usage convert
usage dump
usage estimate
usage filter
usage index_command
usage merge
usage pack
usage phylo
usage predicates
usage query
usage select
usage superkmer
usage unitig
usage utils
Clone
2
usage query
Eric Coissac edited this page 2026-09-12 14:00:23 +02:00
query
Query an index with sequences and annotate each query with the kmer matches found.
obikmer query INDEX INPUTS... [OPTIONS]
Arguments
| Argument | Description |
|---|---|
INDEX |
Index directory to query against |
INPUTS... |
Input sequence files (FASTA/FASTQ, gzip optional); at least one required |
Options
| Option | Default | Description |
|---|---|---|
--detail |
off | Report per-position, per-genome coverage vectors in the output |
--count-missing |
off | Also count query kmers absent from the index |
--force-presence |
off | Report presence (0/1) per genome instead of raw counts |
--presence-threshold |
1 |
Minimum accumulated count to declare a genome present (implies --force-presence) |
-z, --findere-z |
derived from the index metadata | Override the Findere z parameter |
-T, --threads |
detected core count | Number of worker threads |
--chunk-size |
auto-sized (available RAM ÷ threads, clamped to 4–256 MiB) | I/O chunk size, in MiB |
--max-open-files |
threads / 4 (min 1) |
Maximum number of input files open simultaneously |
Output
FASTA on stdout, one record per query, annotated in the OBITools-style header format >id {"key":value,...}:
kmer_count: total number of kmers matchedkmer_missing: number of query kmers absent from the index (only with--count-missing)kmer_strict_matches: per-genome match countscoverage: per-position, per-genome coverage vectors (only with--detail)
--mismatch is accepted by the CLI but not currently functional; using it produces a warning and is ignored.
Wiki sidebar
Theory
Kmer indexing
- DNA encoding
- Kmers
- Minimizer selection
- Super-kmers
- Partitioning and indexing architecture
- Low-complexity kmer filter
Phylogeny
Kmer-based
SNP-based
Usage
- superkmer
- index
- merge
- filter
- select
- query
- dump
- annotate
- phylo
- unitig
- estimate
- convert
- utils
- pack
- Predicates and taxonomy paths