rustkmer 0.5.2

High-performance k-mer counting tool in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

site_name: RustKmer Documentation
site_description: High-performance k-mer counting library and genomic analysis toolkit
site_author: RustKmer Team
site_url: https://rustkmer.github.io

repo_name: rustkmer/rustkmer
repo_url: https://github.com/rustkmer/rustkmer

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.action.edit
    - content.action.view
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - section-index

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/first-steps.md
    - Troubleshooting: getting-started/troubleshooting.md
  - User Guide:
    - user-guide/index.md
    - Counting k-mers: user-guide/counting-kmers.md
    - Querying Databases: user-guide/querying.md
    - Fuzzy Search: user-guide/fuzzy-search.md
    - Performance Tips: user-guide/performance-tips.md
    - CLI: user-guide/cli.md
    - Examples: user-guide/examples.md
    - Tutorials: user-guide/tutorials/index.md
  - API Reference:
    - api-reference/index.md
    - Python:
      - api-reference/overview.md
      - Database: api-reference/database.md
      - Query Results: api-reference/query.md
      - Database Stats: api-reference/stats.md
      - Fuzzy Queries: api-reference/fuzzyquery.md
      - Exceptions: api-reference/exceptions.md
    - Rust:
      - api-reference/rust/index.md
      - KmerCounter: api-reference/rust/counter.md
      - Database: api-reference/rust/database.md
      - Fuzzy Query: api-reference/rust/fuzzy.md
      - CLI: api-reference/rust/cli.md
  - Tutorials:
    - tutorials/index.md
    - Basic Workflow: tutorials/basic-workflow.md
    - Large Genomes: tutorials/large-genomes.md
    - Batch Processing: tutorials/batch-processing.md
    - Integration: tutorials/integration.md
  - Deployment:
    - deployment/index.md
    - Production: deployment/production.md
    - Containers: deployment/containers.md
    - CI/CD: deployment/ci-cd.md
  - Background:
    - background/index.md
    - Algorithms: background/algorithms.md
    - Performance: background/performance.md
    - Comparison: background/comparison.md
  - Appendix:
    - appendix/index.md
    - Troubleshooting: appendix/troubleshooting.md
    - FAQ: appendix/faq.md
    - Changelog: appendix/changelog.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rustkmer/rustkmer

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js