2026-06-04 21:27:01 +02:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
2026-08-15 20:56:29 +02:00
< link rel = "prev" href = "../name-tree/" >
< link rel = "next" href = "../estimate/" >
2026-06-04 21:27:01 +02:00
< link rel = "icon" href = "../../assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-1.6.1, mkdocs-material-9.7.6" >
2026-08-15 20:56:29 +02:00
< title > unitig - obikmer — User Guide</ title >
2026-06-04 21:27:01 +02:00
< link rel = "stylesheet" href = "../../assets/stylesheets/main.484c7ddc.min.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style >: root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" }</ style >
< script > __md_scope = new URL ( "../.." , location ), __md_hash = e =>[... e ]. reduce ((( e , _ )=>( e << 5 ) - e + _ . charCodeAt ( 0 )), 0 ), __md_get = ( e , _ = localStorage , t = __md_scope )=> JSON . parse ( _ . getItem ( t . pathname + "." + e )), __md_set = ( e , _ , t = localStorage , a = __md_scope )=>{ try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ))} catch ( e ){}}</ script >
</ head >
< body dir = "ltr" >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" ></ label >
< div data-md-component = "skip" >
2026-08-15 20:56:29 +02:00
< a href = "#unitig" class = "md-skip" >
2026-06-04 21:27:01 +02:00
Skip to content
</ a >
</ div >
< div data-md-component = "announce" >
</ div >
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
2026-08-15 20:56:29 +02:00
< a href = "../.." title = "obikmer — User Guide" class = "md-header__button md-logo" aria-label = "obikmer — User Guide" data-md-component = "logo" >
2026-06-04 21:27:01 +02:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" >< path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54" /></ svg >
</ a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" >< path d = "M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" /></ svg >
</ label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
obikmer — User Guide
2026-06-04 21:27:01 +02:00
</ span >
</ div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
unitig
2026-06-04 21:27:01 +02:00
</ span >
</ div >
</ div >
</ div >
< script > var palette = __md_get ( "__palette" ); if ( palette && palette . color ){ if ( "(prefers-color-scheme)" === palette . color . media ){ var media = matchMedia ( "(prefers-color-scheme: light)" ), input = document . querySelector ( media . matches ? "[data-md-color-media='(prefers-color-scheme: light)']" : "[data-md-color-media='(prefers-color-scheme: dark)']" ); palette . color . media = input . getAttribute ( "data-md-color-media" ), palette . color . scheme = input . getAttribute ( "data-md-color-scheme" ), palette . color . primary = input . getAttribute ( "data-md-color-primary" ), palette . color . accent = input . getAttribute ( "data-md-color-accent" )} for ( var [ key , value ] of Object . entries ( palette . color )) document . body . setAttribute ( "data-md-color-" + key , value )}</ script >
</ nav >
</ header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
2026-08-15 20:56:29 +02:00
< a href = "../.." title = "obikmer — User Guide" class = "md-nav__button md-logo" aria-label = "obikmer — User Guide" data-md-component = "logo" >
2026-06-04 21:27:01 +02:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" >< path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54" /></ svg >
</ a >
2026-08-15 20:56:29 +02:00
obikmer — User Guide
2026-06-04 21:27:01 +02:00
</ label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../.." class = "md-nav__link" >
< span class = "md-ellipsis" >
Home
</ span >
</ a >
</ li >
2026-08-15 20:56:29 +02:00
< li class = "md-nav__item" >
< a href = "../../installation/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Installation
</ span >
</ a >
</ li >
2026-06-04 21:27:01 +02:00
< li class = "md-nav__item md-nav__item--nested" >
2026-08-15 20:56:29 +02:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_3" >
2026-06-04 21:27:01 +02:00
2026-08-15 20:56:29 +02:00
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
Theory
</ span >
< span class = "md-nav__icon md-icon" ></ span >
</ label >
2026-08-15 20:56:29 +02:00
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_3_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_3" >
2026-06-04 21:27:01 +02:00
< span class = "md-nav__icon md-icon" ></ span >
Theory
</ label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../../theory/kmers_and_superkmers/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
Kmers and super-kmers
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../../theory/encoding/" class = "md-nav__link" >
< span class = "md-ellipsis" >
DNA encoding
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../../theory/entropy_filter/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Low-complexity kmer filter
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../../theory/minimizer_selection/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
Minimizer selection
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../../theory/indexing_architecture/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Partitioning and indexing architecture
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
</ ul >
</ nav >
</ li >
2026-08-15 20:56:29 +02:00
2026-06-04 21:27:01 +02:00
2026-08-15 20:56:29 +02:00
< li class = "md-nav__item md-nav__item--active md-nav__item--nested" >
2026-06-04 21:27:01 +02:00
2026-08-15 20:56:29 +02:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4" checked >
2026-06-04 21:27:01 +02:00
2026-08-15 20:56:29 +02:00
< label class = "md-nav__link" for = "__nav_4" id = "__nav_4_label" tabindex = "0" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Usage
2026-06-04 21:27:01 +02:00
</ span >
< span class = "md-nav__icon md-icon" ></ span >
</ label >
2026-08-15 20:56:29 +02:00
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_4_label" aria-expanded = "true" >
< label class = "md-nav__title" for = "__nav_4" >
2026-06-04 21:27:01 +02:00
< span class = "md-nav__icon md-icon" ></ span >
2026-08-15 20:56:29 +02:00
Usage
2026-06-04 21:27:01 +02:00
</ label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "../superkmer/" class = "md-nav__link" >
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
superkmer
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../index_command/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
index
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../merge/" class = "md-nav__link" >
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
merge
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../filter/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
filter
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../select/" class = "md-nav__link" >
< span class = "md-ellipsis" >
select
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../query/" class = "md-nav__link" >
< span class = "md-ellipsis" >
query
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../dump/" class = "md-nav__link" >
< span class = "md-ellipsis" >
dump
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../annotate/" class = "md-nav__link" >
< span class = "md-ellipsis" >
annotate
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../phylo/" class = "md-nav__link" >
< span class = "md-ellipsis" >
phylo
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../name-tree/" class = "md-nav__link" >
< span class = "md-ellipsis" >
name-tree
</ span >
</ a >
</ li >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
< span class = "md-ellipsis" >
unitig
</ span >
< span class = "md-nav__icon md-icon" ></ span >
</ label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
< span class = "md-ellipsis" >
unitig
</ span >
</ a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" ></ span >
Table of contents
</ label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#arguments" class = "md-nav__link" >
< span class = "md-ellipsis" >
Arguments
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "#options" class = "md-nav__link" >
< span class = "md-ellipsis" >
Options
</ span >
</ a >
</ li >
</ ul >
</ nav >
</ li >
< li class = "md-nav__item" >
< a href = "../estimate/" class = "md-nav__link" >
< span class = "md-ellipsis" >
estimate
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../reindex/" class = "md-nav__link" >
< span class = "md-ellipsis" >
reindex
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../utils/" class = "md-nav__link" >
< span class = "md-ellipsis" >
utils
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../pack/" class = "md-nav__link" >
< span class = "md-ellipsis" >
pack
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
< a href = "../predicates/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Predicates and taxonomy paths
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
</ ul >
</ nav >
</ li >
< li class = "md-nav__item md-nav__item--nested" >
2026-08-15 20:56:29 +02:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_5" >
2026-06-04 21:27:01 +02:00
2026-08-15 20:56:29 +02:00
< label class = "md-nav__link" for = "__nav_5" id = "__nav_5_label" tabindex = "0" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Formats
2026-06-04 21:27:01 +02:00
</ span >
< span class = "md-nav__icon md-icon" ></ span >
</ label >
2026-08-15 20:56:29 +02:00
< nav class = "md-nav" data-md-level = "1" aria-labelledby = "__nav_5_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_5" >
2026-06-04 21:27:01 +02:00
< span class = "md-nav__icon md-icon" ></ span >
2026-08-15 20:56:29 +02:00
Formats
2026-06-04 21:27:01 +02:00
</ label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "../../formats/index_layout/" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Index construction and on-disk layout
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
</ ul >
</ nav >
</ li >
2026-08-15 20:56:29 +02:00
< li class = "md-nav__item" >
< a href = "../../architecture/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Architecture notes
</ span >
</ a >
</ li >
2026-06-04 21:27:01 +02:00
</ ul >
</ nav >
</ div >
</ div >
</ div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" ></ span >
Table of contents
</ label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "#arguments" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Arguments
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
< li class = "md-nav__item" >
2026-08-15 20:56:29 +02:00
< a href = "#options" class = "md-nav__link" >
2026-06-04 21:27:01 +02:00
< span class = "md-ellipsis" >
2026-08-15 20:56:29 +02:00
Options
2026-06-04 21:27:01 +02:00
</ span >
</ a >
</ li >
</ ul >
</ nav >
</ div >
</ div >
</ div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
2026-08-15 20:56:29 +02:00
< h1 id = "unitig" > unitig</ h1 >
< p > Dump the unitigs of an index as FASTA. A unitig is a maximal non-branching path through the de Bruijn graph implied by the index's kmers; the concatenation of every unitig reconstructs every stored kmer exactly once.</ p >
< div class = "highlight" >< pre >< span ></ span >< code > obikmer< span class = "w" > </ span > unitig< span class = "w" > </ span > INDEX< span class = "w" > </ span >< span class = "o" > [</ span > OPTIONS< span class = "o" > ]</ span >
</ code ></ pre ></ div >
< h2 id = "arguments" > Arguments</ h2 >
< table >
< thead >
< tr >
< th > Argument</ th >
< th > Description</ th >
</ tr >
</ thead >
< tbody >
< tr >
< td >< code > INDEX</ code ></ td >
< td > Index directory</ td >
</ tr >
</ tbody >
</ table >
< h2 id = "options" > Options</ h2 >
< p >< code > unitig</ code > accepts the shared < a href = "../filter/#predicate-options" > predicate options</ a > (< code > --ingroup</ code > , < code > --outgroup</ code > , < code > --min-count</ code > , etc.) to restrict which kmers are included before the unitigs are enumerated.</ p >
< p > Output is FASTA on stdout.</ p >
2026-06-04 21:27:01 +02:00
</ article >
</ div >
< script > var target = document . getElementById ( location . hash . slice ( 1 )); target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ))</ script >
</ div >
</ main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
</ a >
</ div >
</ div >
</ div >
</ footer >
</ div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" ></ div >
</ div >
< script id = "__config" type = "application/json" >{ "annotate" : null , "base" : "../.." , "features" : [], "search" : "../../assets/javascripts/workers/search.2c215733.min.js" , "tags" : null , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" }, "version" : null }</ script >
< script src = "../../assets/javascripts/bundle.79ae519e.min.js" ></ script >
< script src = "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js" ></ script >
</ body >
</ html >
