site_name: obikmer — User Guide docs_dir: UserDocMD site_dir: doc theme: name: material plugins: - mermaid2: - bibtex: bib_file: UserDocMD/references.bib csl_file: UserDocMD/molecular-ecology-modified.csl enable_inline_citations: false markdown_extensions: - admonition - footnotes - tables - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.arithmatex: generic: true extra_javascript: - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js nav: - Home: index.md - Installation: installation.md - Theory: - Kmer indexing: - DNA encoding: theory/kmer_indexing/encoding.md - Kmers: theory/kmer_indexing/kmers.md - Minimizer selection: theory/kmer_indexing/minimizer_selection.md - Super-kmers: theory/kmer_indexing/superkmers.md - Partitioning and indexing architecture: theory/kmer_indexing/indexing_architecture.md - Low-complexity kmer filter: theory/kmer_indexing/entropy_filter.md - Phylogeny: - Kmer-based: - Whole k-mer set distances: theory/phylogeny/kmer_based/kmer_set_distances.md - SNP-based: - Central-position SNP model: theory/phylogeny/snp_based/central_snp_model.md - Gamma rate heterogeneity: theory/phylogeny/snp_based/gamma_rate_heterogeneity.md - Sankoff model: theory/phylogeny/snp_based/sankoff_model.md - Sampling design: theory/phylogeny/snp_based/sampling_design.md - Usage: - superkmer: usage/superkmer.md - index: usage/index_command.md - merge: usage/merge.md - filter: usage/filter.md - select: usage/select.md - query: usage/query.md - dump: usage/dump.md - annotate: usage/annotate.md - phylo: usage/phylo.md - unitig: usage/unitig.md - estimate: usage/estimate.md - convert: usage/convert.md - utils: usage/utils.md - pack: usage/pack.md - Predicates and taxonomy paths: usage/predicates.md - Formats: - Index construction and on-disk layout: formats/index_layout.md - VCF pseudo-alignment: formats/vcf.md - Architecture notes: architecture.md watch: - UserDocMD - mkdocs-user.yml