Files
OBIJupyterHub/jupyterhub_volumes/web/obidoc/index.xml

41 lines
18 KiB
XML
Raw Normal View History

2025-11-16 14:56:03 +01:00
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>OBITools4 Documentation on OBITools4 documentation</title>
<link>http://metabar:8888/obidoc/</link>
<description>Recent content in OBITools4 Documentation on OBITools4 documentation</description>
<generator>Hugo</generator>
<language>en-us</language>
<lastBuildDate>Fri, 04 Oct 2024 17:16:03 +0200</lastBuildDate>
<atom:link href="http://metabar:8888/obidoc/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>About</title>
<link>http://metabar:8888/obidoc/docs/about/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://metabar:8888/obidoc/docs/about/</guid>
<description>&lt;h2 id=&#34;what-are-obitools4&#34;&gt;&#xA; What are OBITools4?&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#what-are-obitools4&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h2&gt;&#xA;&lt;p&gt;The development of &lt;abbr title=&#34;A set of unix command line tools for manipulating DNA metabarcoding data&#34;&gt;OBITools&lt;/abbr&gt;&#xA; began at &#xA; &lt;a href=&#34;https://leca.osug.fr&#34;&gt;&lt;abbr title=&#34;LECA: Laboratoire d&amp;#39;écologie Alpine - Laboratory for Alpine Ecology&#34;&gt;LECA&lt;/abbr&gt;&#xA; &#xA; &lt;/a&gt; (&#xA; &lt;a href=&#34;https://www.univ-grenoble-alpes.fr/&#34;&gt;University of Grenoble&lt;/a&gt;) in the early 2000s, at the same time as the development of DNA metabarcoding methods in the same laboratory. The idea behind the OBITools project was to provide a set of UNIX command-line tools that mimic standard UNIX shell commands such as &lt;code&gt;grep&lt;/code&gt;, &lt;code&gt;uniq&lt;/code&gt; or &lt;code&gt;wc&lt;/code&gt;, but which work on DNA sequence files. Unlike standard UNIX tools, where the processing unit is a line of text, with OBITools the processing unit is a sequence record. In addition, some commands implementing algorithms specific to the processing of DNA metabarcoding data have been added, making &lt;abbr title=&#34;A set of unix command line tools for manipulating DNA metabarcoding data&#34;&gt;OBITools&lt;/abbr&gt;&#xA; one of the sequence processing tools widely used on UNIX-like systems, suitable for the analysis of DNA metabarcoding data.&lt;/p&gt;</description>
</item>
<item>
<title>Regular Expressions</title>
<link>http://metabar:8888/obidoc/docs/patterns/regular/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://metabar:8888/obidoc/docs/patterns/regular/</guid>
<description>&lt;h1 id=&#34;regular-expressions&#34;&gt;&#xA; Regular Expressions&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#regular-expressions&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h1&gt;&#xA;&lt;p&gt;Regular expressions are a powerful tool for describing patterns in text. They are used in several &lt;abbr title=&#34;A set of unix command line tools for manipulating DNA metabarcoding data&#34;&gt;OBITools&lt;/abbr&gt;&#xA; like &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obigrep/&#34;&gt;&#xA; &lt;abbr title=&#34;obigrep: filter a sequence file&#34;&gt;&lt;code&gt;obigrep&lt;/code&gt;&lt;/abbr&gt;&#xA; &lt;/a&gt;, &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obiannotate/&#34;&gt;&#xA; &lt;abbr title=&#34;obiannotate: edit sequence annotations&#34;&gt;&lt;code&gt;obiannotate&lt;/code&gt;&lt;/abbr&gt;&#xA; &lt;/a&gt; or &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obiscript/&#34;&gt;&#xA; &lt;abbr title=&#34;obiscript: apply a LUA script to a sequence file&#34;&gt;&lt;code&gt;obiscript&lt;/code&gt;&lt;/abbr&gt;&#xA; &lt;/a&gt;.&lt;/p&gt;&#xA;&lt;h2 id=&#34;single-characters&#34;&gt;&#xA; Single characters&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#single-characters&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h2&gt;&#xA;&lt;table&gt;&#xA; &lt;thead&gt;&#xA; &lt;tr&gt;&#xA; &lt;th&gt;Pattern&lt;/th&gt;&#xA; &lt;th&gt;Description&lt;/th&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/thead&gt;&#xA; &lt;tbody&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;.&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;any character, possibly including newline (flag s=true)&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;[xyz]&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;character class&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;[^xyz]&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;negated character class&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;[[:alpha:]]&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;ASCII character class&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;[[:^alpha:]]&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;negated ASCII character class&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/tbody&gt;&#xA;&lt;/table&gt;&#xA;&lt;h2 id=&#34;composites&#34;&gt;&#xA; Composites&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#composites&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h2&gt;&#xA;&lt;table&gt;&#xA; &lt;thead&gt;&#xA; &lt;tr&gt;&#xA; &lt;th&gt;Pattern&lt;/th&gt;&#xA; &lt;th&gt;Description&lt;/th&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/thead&gt;&#xA; &lt;tbody&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;xy&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;x followed by y&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;x|y&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;x or y (prefer x)&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/tbody&gt;&#xA;&lt;/table&gt;&#xA;&lt;h2 id=&#34;repetitions&#34;&gt;&#xA; Repetitions&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#repetitions&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h2&gt;&#xA;&lt;table&gt;&#xA; &lt;thead&gt;&#xA; &lt;tr&gt;&#xA; &lt;th&gt;Pattern&lt;/th&gt;&#xA; &lt;th&gt;Description&lt;/th&gt;&#xA; &lt;/tr&gt;&#xA; &lt;/thead&gt;&#xA; &lt;tbody&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;x*&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;zero or more x, prefer more&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;x+&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;one or more x, prefer more&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;x?&lt;/code&gt;&lt;/td&gt;&#xA; &lt;td&gt;zero or one x, prefer one&lt;/td&gt;&#xA; &lt;/tr&gt;&#xA; &lt;tr&gt;&#xA; &lt;td&gt;&lt;code&gt;x{n,m}&lt;/code&gt;&lt;/td&gt;&#xA; &lt;
</item>
<item>
<title>DNA Patterns</title>
<link>http://metabar:8888/obidoc/docs/patterns/dnagrep/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://metabar:8888/obidoc/docs/patterns/dnagrep/</guid>
<description>&lt;h1 id=&#34;dna-patterns&#34;&gt;&#xA; DNA Patterns&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#dna-patterns&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h1&gt;&#xA;&lt;p&gt;DNA patterns are useful for describing short DNA sequences like oligonucleotides. They are used by several &lt;abbr title=&#34;A set of unix command line tools for manipulating DNA metabarcoding data&#34;&gt;OBITools&lt;/abbr&gt;&#xA; like &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obimultiplex/&#34;&gt;&#xA; &lt;abbr title=&#34;obimultiplex: &#34;&gt;&lt;code&gt;obimultiplex&lt;/code&gt;&lt;/abbr&gt;&#xA; &lt;/a&gt;, &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obipcr/&#34;&gt;&#xA; &lt;abbr title=&#34;obipcr: the electronic PCR tool&#34;&gt;&lt;code&gt;obipcr&lt;/code&gt;&lt;/abbr&gt;&#xA; &lt;/a&gt; or &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obigrep/&#34;&gt;&#xA; &lt;abbr title=&#34;obigrep: filter a sequence file&#34;&gt;&lt;code&gt;obigrep&lt;/code&gt;&lt;/abbr&gt;&#xA; &lt;/a&gt;. The advantage of using DNA patterns over classical regular expressions is that they can be matched with errors. Allowed errors can be simple mismatches, or mismatches and insertions/deletions.&lt;/p&gt;</description>
</item>
<item>
<title>Glossary of tags</title>
<link>http://metabar:8888/obidoc/docs/commands/tags/</link>
<pubDate>Fri, 04 Oct 2024 17:16:03 +0200</pubDate>
<guid>http://metabar:8888/obidoc/docs/commands/tags/</guid>
<description>&lt;h1 id=&#34;glossary-of-tags&#34;&gt;&#xA; Glossary of tags&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#glossary-of-tags&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h1&gt;&#xA;&lt;h3 id=&#34;--d--&#34;&gt;&#xA; - D -&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#--d--&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h3&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;&#xA;&lt;p&gt;&lt;strong&gt;definition&lt;/strong&gt; :&lt;/p&gt;&#xA;&lt;blockquote&gt;&#xA;&lt;p&gt;text information about the sequence present in the original sequence file.&lt;/p&gt;&#xA;&lt;/blockquote&gt;&#xA;&lt;/li&gt;&#xA;&lt;li&gt;&#xA;&lt;p&gt;&lt;strong&gt;direction&lt;/strong&gt; :&lt;/p&gt;&#xA;&lt;blockquote&gt;&#xA;&lt;p&gt;set to “forward” if the original sequence did not need to be reverse-complemented to be processed, set to “reverse” otherwise.&#xA;(&#xA; &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obipcr/&#34;&gt;obipcr&lt;/a&gt;)&lt;/p&gt;&#xA;&lt;/blockquote&gt;&#xA;&lt;/li&gt;&#xA;&lt;/ul&gt;&#xA;&lt;h3 id=&#34;--f--&#34;&gt;&#xA; - F -&#xA; &lt;a class=&#34;anchor&#34; href=&#34;#--f--&#34;&gt;#&lt;/a&gt;&#xA;&lt;/h3&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;&#xA;&lt;p&gt;&lt;strong&gt;forward_error&lt;/strong&gt; :&lt;/p&gt;&#xA;&lt;blockquote&gt;&#xA;&lt;p&gt;Number of mismatch between forward primer and priming site&#xA;(&#xA; &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obipcr/&#34;&gt;obipcr&lt;/a&gt;)&lt;/p&gt;&#xA;&lt;/blockquote&gt;&#xA;&lt;/li&gt;&#xA;&lt;li&gt;&#xA;&lt;p&gt;&lt;strong&gt;forward_match&lt;/strong&gt; :&lt;/p&gt;&#xA;&lt;blockquote&gt;&#xA;&lt;p&gt;Forward primer priming site sequence&#xA;(&#xA; &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obipcr/&#34;&gt;obipcr&lt;/a&gt;)&lt;/p&gt;&#xA;&lt;/blockquote&gt;&#xA;&lt;/li&gt;&#xA;&lt;li&gt;&#xA;&lt;p&gt;&lt;strong&gt;forward_primer&lt;/strong&gt; :&lt;/p&gt;&#xA;&lt;blockquote&gt;&#xA;&lt;p&gt;Forward primer sequence&#xA;(&#xA; &lt;a href=&#34;http://metabar:8888/obidoc/obitools/obipcr/&#34;&gt;obipcr&lt;/a&gt;)&lt;/p&gt;</description>
</item>
</channel>
</rss>