mirror of
https://github.com/metabarcoding/obitools4.git
synced 2025-06-29 16:20:46 +00:00
422 lines
19 KiB
HTML
422 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="generator" content="quarto-1.2.256">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
|
|
|
|
|
|
<title>OBITools V4 - 5 Controling OBITools outputs</title>
|
|
<style>
|
|
code{white-space: pre-wrap;}
|
|
span.smallcaps{font-variant: small-caps;}
|
|
div.columns{display: flex; gap: min(4vw, 1.5em);}
|
|
div.column{flex: auto; overflow-x: auto;}
|
|
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
|
ul.task-list{list-style: none;}
|
|
ul.task-list li input[type="checkbox"] {
|
|
width: 0.8em;
|
|
margin: 0 0.8em 0.2em -1.6em;
|
|
vertical-align: middle;
|
|
}
|
|
</style>
|
|
|
|
|
|
<script src="site_libs/quarto-nav/quarto-nav.js"></script>
|
|
<script src="site_libs/quarto-nav/headroom.min.js"></script>
|
|
<script src="site_libs/clipboard/clipboard.min.js"></script>
|
|
<script src="site_libs/quarto-search/autocomplete.umd.js"></script>
|
|
<script src="site_libs/quarto-search/fuse.min.js"></script>
|
|
<script src="site_libs/quarto-search/quarto-search.js"></script>
|
|
<meta name="quarto:offset" content="./">
|
|
<link href="./common_options.html" rel="next">
|
|
<link href="./inupt.html" rel="prev">
|
|
<script src="site_libs/quarto-html/quarto.js"></script>
|
|
<script src="site_libs/quarto-html/popper.min.js"></script>
|
|
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
|
|
<script src="site_libs/quarto-html/anchor.min.js"></script>
|
|
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
|
|
<link href="site_libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
|
|
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
|
|
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
|
|
<link href="site_libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
|
|
<script id="quarto-search-options" type="application/json">{
|
|
"location": "sidebar",
|
|
"copy-button": false,
|
|
"collapse-after": 3,
|
|
"panel-placement": "start",
|
|
"type": "textbox",
|
|
"limit": 20,
|
|
"language": {
|
|
"search-no-results-text": "No results",
|
|
"search-matching-documents-text": "matching documents",
|
|
"search-copy-link-title": "Copy link to search",
|
|
"search-hide-matches-text": "Hide additional matches",
|
|
"search-more-match-text": "more match in this document",
|
|
"search-more-matches-text": "more matches in this document",
|
|
"search-clear-button-title": "Clear",
|
|
"search-detached-cancel-button-title": "Cancel",
|
|
"search-submit-button-title": "Submit"
|
|
}
|
|
}</script>
|
|
|
|
|
|
</head>
|
|
|
|
<body class="nav-sidebar floating">
|
|
|
|
<div id="quarto-search-results"></div>
|
|
<header id="quarto-header" class="headroom fixed-top">
|
|
<nav class="quarto-secondary-nav" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
|
|
<div class="container-fluid d-flex justify-content-between">
|
|
<h1 class="quarto-secondary-nav-title"><span class="chapter-number">5</span> <span class="chapter-title">Controling OBITools outputs</span></h1>
|
|
<button type="button" class="quarto-btn-toggle btn" aria-label="Show secondary navigation">
|
|
<i class="bi bi-chevron-right"></i>
|
|
</button>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
<!-- content -->
|
|
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
|
|
<!-- sidebar -->
|
|
<nav id="quarto-sidebar" class="sidebar collapse sidebar-navigation floating overflow-auto">
|
|
<div class="pt-lg-2 mt-2 text-left sidebar-header">
|
|
<div class="sidebar-title mb-0 py-0">
|
|
<a href="./">OBITools V4</a>
|
|
</div>
|
|
</div>
|
|
<div class="mt-2 flex-shrink-0 align-items-center">
|
|
<div class="sidebar-search">
|
|
<div id="quarto-search" class="" title="Search"></div>
|
|
</div>
|
|
</div>
|
|
<div class="sidebar-menu-container">
|
|
<ul class="list-unstyled mt-1">
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./index.html" class="sidebar-item-text sidebar-link">Preface</a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item sidebar-item-section">
|
|
<div class="sidebar-item-container">
|
|
<a href="./intro.html" class="sidebar-item-text sidebar-link">The OBITools</a>
|
|
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true">
|
|
<i class="bi bi-chevron-right ms-2"></i>
|
|
</a>
|
|
</div>
|
|
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./installation.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">1</span> <span class="chapter-title">Installation of the <em>OBITools</em></span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./formats.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">2</span> <span class="chapter-title">File formats usable with <em>OBITools</em></span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./tutorial.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">3</span> <span class="chapter-title">OBITools V4 Tutorial</span></a>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="sidebar-item sidebar-item-section">
|
|
<div class="sidebar-item-container">
|
|
<a href="./commands.html" class="sidebar-item-text sidebar-link">The *OBITools V4* commands</a>
|
|
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" aria-expanded="true">
|
|
<i class="bi bi-chevron-right ms-2"></i>
|
|
</a>
|
|
</div>
|
|
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./inupt.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">4</span> <span class="chapter-title">Specifying the data input to <em>OBITools</em> commands</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./output.html" class="sidebar-item-text sidebar-link active"><span class="chapter-number">5</span> <span class="chapter-title">Controling OBITools outputs</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./common_options.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">6</span> <span class="chapter-title">Options common to most of the <em>OBITools</em> commands</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./expressions.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">7</span> <span class="chapter-title">OBITools expression language</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./comm_metabarcode_design.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">8</span> <span class="chapter-title">Metabarcode design and quality assessment</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./comm_reformat.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">9</span> <span class="chapter-title">File format conversions</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./comm_annotation.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">10</span> <span class="chapter-title">Sequence annotations</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./comm_computation.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">11</span> <span class="chapter-title">Computations on sequences</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./comm_sampling.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">12</span> <span class="chapter-title">Sequence sampling and filtering</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./comm_utilities.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">13</span> <span class="chapter-title">Utilities</span></a>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="sidebar-item sidebar-item-section">
|
|
<span class="sidebar-item-text sidebar-link text-start">The GO *OBITools* library</span>
|
|
</li>
|
|
<li class="sidebar-item sidebar-item-section">
|
|
<div class="sidebar-item-container">
|
|
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" aria-expanded="true">Appendices</a>
|
|
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" aria-expanded="true">
|
|
<i class="bi bi-chevron-right ms-2"></i>
|
|
</a>
|
|
</div>
|
|
<ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth1 show">
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./annexes.html" class="sidebar-item-text sidebar-link"><span class="chapter-number">A</span> <span class="chapter-title">Annexes</span></a>
|
|
</div>
|
|
</li>
|
|
<li class="sidebar-item">
|
|
<div class="sidebar-item-container">
|
|
<a href="./references.html" class="sidebar-item-text sidebar-link">References</a>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
<!-- margin-sidebar -->
|
|
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
|
|
<nav id="TOC" role="doc-toc" class="toc-active">
|
|
<h2 id="toc-title">Table of contents</h2>
|
|
|
|
<ul>
|
|
<li><a href="#specifying-output-format" id="toc-specifying-output-format" class="nav-link active" data-scroll-target="#specifying-output-format"><span class="toc-section-number">5.1</span> Specifying output format</a></li>
|
|
<li><a href="#the-fasta-and-fastq-annotations-format" id="toc-the-fasta-and-fastq-annotations-format" class="nav-link" data-scroll-target="#the-fasta-and-fastq-annotations-format"><span class="toc-section-number">5.2</span> The Fasta and Fastq annotations format</a></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<!-- main -->
|
|
<main class="content" id="quarto-document-content">
|
|
|
|
<header id="title-block-header" class="quarto-title-block default">
|
|
<div class="quarto-title">
|
|
<h1 class="title d-none d-lg-block"><span class="chapter-number">5</span> <span class="chapter-title">Controling OBITools outputs</span></h1>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="quarto-title-meta">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</header>
|
|
|
|
<section id="specifying-output-format" class="level2" data-number="5.1">
|
|
<h2 data-number="5.1" class="anchored" data-anchor-id="specifying-output-format"><span class="header-section-number">5.1</span> Specifying output format</h2>
|
|
<p>Only two output sequence formats are supported by OBITools, Fasta and Fastq. Fastq is used when output sequences are associated with quality information. Otherwise, Fasta is the default format. However, it is possible to force the output format by using one of the following two options. Forcing the use of Fasta results in the loss of quality information. Conversely, when the Fastq format is forced with sequences that have no quality data, dummy qualities set to 40 for each nucleotide are added.</p>
|
|
<ul>
|
|
<li><code>--fasta-output</code> Read data following the ecoPCR output format.</li>
|
|
<li><code>--fastq-output</code> Read data following the EMBL flatfile format.</li>
|
|
</ul>
|
|
<p>OBITools allows multiple input files to be specified for a single command.</p>
|
|
<ul>
|
|
<li><code>--no-order</code> When several input files are provided, indicates that there is no order among them. (default: false). Using such option can increase a lot the processing of the data.</li>
|
|
</ul>
|
|
</section>
|
|
<section id="the-fasta-and-fastq-annotations-format" class="level2" data-number="5.2">
|
|
<h2 data-number="5.2" class="anchored" data-anchor-id="the-fasta-and-fastq-annotations-format"><span class="header-section-number">5.2</span> The Fasta and Fastq annotations format</h2>
|
|
<p>OBITools extend the <a href="#the-fasta-sequence-format">Fasta</a> and <a href="#the-fastq-sequence-format">Fastq</a> formats by introducing a format for the title lines of these formats allowing to annotate every sequence. While the previous version of OBITools used an <em>ad-hoc</em> format for these annotation, this new version introduce the usage of the standard JSON format to store them.</p>
|
|
<p>On input, OBITools automatically recognize the format of the annotations, but two options allows to force the parsing following one of them. You should normally not need to use these options.</p>
|
|
<ul>
|
|
<li><p><code>--input-OBI-header</code> FASTA/FASTQ title line annotations follow OBI format. (default: false)</p></li>
|
|
<li><p><code>--input-json-header</code> FASTA/FASTQ title line annotations follow json format. (default: false)</p></li>
|
|
</ul>
|
|
<p>On output, by default annotation are formatted using the new JSON format. For compatibility with previous version of OBITools and with external scripts and software, it is possible to force the usage of the previous OBITools format.</p>
|
|
<ul>
|
|
<li><p><code>--output-OBI-header|-O</code> output FASTA/FASTQ title line annotations follow OBI format. (default: false)</p></li>
|
|
<li><p><code>--output-json-header</code> output FASTA/FASTQ title line annotations follow json format. (default: false)</p></li>
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
</main> <!-- /main -->
|
|
<script id="quarto-html-after-body" type="application/javascript">
|
|
window.document.addEventListener("DOMContentLoaded", function (event) {
|
|
const toggleBodyColorMode = (bsSheetEl) => {
|
|
const mode = bsSheetEl.getAttribute("data-mode");
|
|
const bodyEl = window.document.querySelector("body");
|
|
if (mode === "dark") {
|
|
bodyEl.classList.add("quarto-dark");
|
|
bodyEl.classList.remove("quarto-light");
|
|
} else {
|
|
bodyEl.classList.add("quarto-light");
|
|
bodyEl.classList.remove("quarto-dark");
|
|
}
|
|
}
|
|
const toggleBodyColorPrimary = () => {
|
|
const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");
|
|
if (bsSheetEl) {
|
|
toggleBodyColorMode(bsSheetEl);
|
|
}
|
|
}
|
|
toggleBodyColorPrimary();
|
|
const icon = "";
|
|
const anchorJS = new window.AnchorJS();
|
|
anchorJS.options = {
|
|
placement: 'right',
|
|
icon: icon
|
|
};
|
|
anchorJS.add('.anchored');
|
|
const clipboard = new window.ClipboardJS('.code-copy-button', {
|
|
target: function(trigger) {
|
|
return trigger.previousElementSibling;
|
|
}
|
|
});
|
|
clipboard.on('success', function(e) {
|
|
// button target
|
|
const button = e.trigger;
|
|
// don't keep focus
|
|
button.blur();
|
|
// flash "checked"
|
|
button.classList.add('code-copy-button-checked');
|
|
var currentTitle = button.getAttribute("title");
|
|
button.setAttribute("title", "Copied!");
|
|
let tooltip;
|
|
if (window.bootstrap) {
|
|
button.setAttribute("data-bs-toggle", "tooltip");
|
|
button.setAttribute("data-bs-placement", "left");
|
|
button.setAttribute("data-bs-title", "Copied!");
|
|
tooltip = new bootstrap.Tooltip(button,
|
|
{ trigger: "manual",
|
|
customClass: "code-copy-button-tooltip",
|
|
offset: [0, -8]});
|
|
tooltip.show();
|
|
}
|
|
setTimeout(function() {
|
|
if (tooltip) {
|
|
tooltip.hide();
|
|
button.removeAttribute("data-bs-title");
|
|
button.removeAttribute("data-bs-toggle");
|
|
button.removeAttribute("data-bs-placement");
|
|
}
|
|
button.setAttribute("title", currentTitle);
|
|
button.classList.remove('code-copy-button-checked');
|
|
}, 1000);
|
|
// clear code selection
|
|
e.clearSelection();
|
|
});
|
|
function tippyHover(el, contentFn) {
|
|
const config = {
|
|
allowHTML: true,
|
|
content: contentFn,
|
|
maxWidth: 500,
|
|
delay: 100,
|
|
arrow: false,
|
|
appendTo: function(el) {
|
|
return el.parentElement;
|
|
},
|
|
interactive: true,
|
|
interactiveBorder: 10,
|
|
theme: 'quarto',
|
|
placement: 'bottom-start'
|
|
};
|
|
window.tippy(el, config);
|
|
}
|
|
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
|
|
for (var i=0; i<noterefs.length; i++) {
|
|
const ref = noterefs[i];
|
|
tippyHover(ref, function() {
|
|
// use id or data attribute instead here
|
|
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
|
|
try { href = new URL(href).hash; } catch {}
|
|
const id = href.replace(/^#\/?/, "");
|
|
const note = window.document.getElementById(id);
|
|
return note.innerHTML;
|
|
});
|
|
}
|
|
const findCites = (el) => {
|
|
const parentEl = el.parentElement;
|
|
if (parentEl) {
|
|
const cites = parentEl.dataset.cites;
|
|
if (cites) {
|
|
return {
|
|
el,
|
|
cites: cites.split(' ')
|
|
};
|
|
} else {
|
|
return findCites(el.parentElement)
|
|
}
|
|
} else {
|
|
return undefined;
|
|
}
|
|
};
|
|
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
|
|
for (var i=0; i<bibliorefs.length; i++) {
|
|
const ref = bibliorefs[i];
|
|
const citeInfo = findCites(ref);
|
|
if (citeInfo) {
|
|
tippyHover(citeInfo.el, function() {
|
|
var popup = window.document.createElement('div');
|
|
citeInfo.cites.forEach(function(cite) {
|
|
var citeDiv = window.document.createElement('div');
|
|
citeDiv.classList.add('hanging-indent');
|
|
citeDiv.classList.add('csl-entry');
|
|
var biblioDiv = window.document.getElementById('ref-' + cite);
|
|
if (biblioDiv) {
|
|
citeDiv.innerHTML = biblioDiv.innerHTML;
|
|
}
|
|
popup.appendChild(citeDiv);
|
|
});
|
|
return popup.innerHTML;
|
|
});
|
|
}
|
|
}
|
|
});
|
|
</script>
|
|
<nav class="page-navigation">
|
|
<div class="nav-page nav-page-previous">
|
|
<a href="./inupt.html" class="pagination-link">
|
|
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text"><span class="chapter-number">4</span> <span class="chapter-title">Specifying the data input to <em>OBITools</em> commands</span></span>
|
|
</a>
|
|
</div>
|
|
<div class="nav-page nav-page-next">
|
|
<a href="./common_options.html" class="pagination-link">
|
|
<span class="nav-page-text"><span class="chapter-number">6</span> <span class="chapter-title">Options common to most of the <em>OBITools</em> commands</span></span> <i class="bi bi-arrow-right-short"></i>
|
|
</a>
|
|
</div>
|
|
</nav>
|
|
</div> <!-- /content -->
|
|
|
|
|
|
|
|
</body></html> |