Debian Codegraph @

docs/html/_m_a_n_u_a_l_8md_source.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.14"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>iVar: docs/MANUAL.md Source File</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td id="projectalign" style="padding-left: 0.5em;">
24 <div id="projectname">iVar
25 </div>
26 </td>
27 </tr>
28 </tbody>
29 </table>
30 </div>
31 <!-- end header part -->
32 <!-- Generated by Doxygen 1.8.14 -->
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 /* @license-end */
37 </script>
38 <script type="text/javascript" src="menudata.js"></script>
39 <script type="text/javascript" src="menu.js"></script>
40 <script type="text/javascript">
41 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42 $(function() {
43 initMenu('',true,false,'search.php','Search');
44 $(document).ready(function() { init_search(); });
45 });
46 /* @license-end */</script>
47 <div id="main-nav"></div>
48 </div><!-- top -->
49 <!-- window showing the filter options -->
50 <div id="MSearchSelectWindow"
51 onmouseover="return searchBox.OnSearchSelectShow()"
52 onmouseout="return searchBox.OnSearchSelectHide()"
53 onkeydown="return searchBox.OnSearchSelectKey(event)">
54 </div>
55
56 <!-- iframe showing the search results (closed by default) -->
57 <div id="MSearchResultsWindow">
58 <iframe src="javascript:void(0)" frameborder="0"
59 name="MSearchResults" id="MSearchResults">
60 </iframe>
61 </div>
62
63 <div class="header">
64 <div class="headertitle">
65 <div class="title">docs/MANUAL.md</div> </div>
66 </div><!--header-->
67 <div class="contents">
68 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;Manual {#manualpage}</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;============</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;## Available Commands</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;| Command | Description |</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;|:--------|:------------|</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;| trim | Trim reads in aligned BAMs |</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;| variants | Call variants from aligned BAM file |</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;| filtervariants | Filter variants across replicates</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;| consensus | Call consensus from aligned BAM file |</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;| getmasked | Get amplicons with primer mismatches |</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;| removereads | Remove reads from trimmed BAM file |</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;| version | Show version information |</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;| trimadapter | (EXPERIMENTAL) Trim adapter sequences from reads |</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;To view detailed usage for each command type `ivar &lt;command&gt;`</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;Note : Commands maked (EXPERIMENTAL) are still under active development.</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;## Description of commands</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;#### Trim primer sequences with iVar</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;Command:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;```</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;ivar trim</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;Usage: ivar trim -i &lt;input.bam&gt; -b &lt;primers.bed&gt; -p prefix [-m &lt;min-length&gt;] [-q &lt;min-quality&gt;] [-s &lt;sliding-window-width&gt;]</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;Input Options Description</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; -i (Required) &lt;input.bam&gt; Indexed aligned bam file to trim primers and quality</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; -b (Required) &lt;primers.bed&gt; BED file with primer sequences and positions</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; -m Minimum length of read to retain after trimming (Default: 30)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; -q Minimum quality threshold for sliding window to pass (Default: 20)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; -s Width of sliding window (Default: 4)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;Output Options Description</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; -p (Required) Prefix for the output BAM file</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;```</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;Example Usage:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;```</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;```</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;#### Call variants with iVar</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;Command:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;```</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;ivar variants</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;Usage: samtools mpileup -A -d 300000 --reference &lt;reference-fasta&gt; -Q 0 -F 0 &lt;input-bam&gt; | ivar variants -p prefix [-q &lt;min-quality&gt;] [-t &lt;min-frequency-threshold&gt;]</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;Note : samtools mpileup output must be piped into ivar variants</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;Input Options Description</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; -q &lt;min-quality&gt; Minimum quality threshold to count base (Default: 20)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; -t &lt;min-frequency-threshold&gt; Minimum frequency threshold(0 - 1) to call variants (Default: 0.03)</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;Output Options Description</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; -p (Required) Prefix, prefix for the output tsv variant file</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;```</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;Example Usage:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;```</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;```</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;#### Filter variants across replicates with iVar</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;Command:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;```</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;ivar filtervariants</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;Usage: ivar filtervariants [-p prefix] replicate-one.tsv replicate-two.csv ...</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;Output Options Description</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; -p (Required) Prefix, prefix for the filtered tsv file</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;```</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;Example Usage:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;```</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;```</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;#### Call a consensus sequences from an aligned BAM file.</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;Command:</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;```</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;ivar consensus</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;Usage: samtools mpileup -A -d 300000 -Q 0 -F 0 [&lt;input-bam&gt;] | ivar consensus [-p prefix]</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;Note : samtools mpileup output must be piped into &quot;ivar consensus&quot;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;Input Options Description</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; -q Minimum quality threshold to count base (Default: 20)</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; -t Threshold(0 - 100) to call consensus (Default: 0)</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;Output Options Description</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; -p (Required) Prefix, prefix for the output tsv file</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;```</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;Example Usage:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;```</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;```</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;#### Get primers with mismatches to the reference sequence.</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;Command:</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;```</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;ivar getmasked</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;Usage: ivar getmasked [-i &lt;input-filtered-tsv&gt;] [-b &lt;bed-file&gt;]</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;Input Options Description</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; -i (Required) Input filtered variants tsv generated from &quot;ivar filtervariants&quot;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; -b (Required) Bed file with primer indices</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;```</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;Example Usage:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;```</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;```</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;#### Remove reads associated with mismatched primer indices</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;Command:</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;```</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;ivar removereads</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;Usage: ivar removereads [-i &lt;input-bam&gt;] [-p prefix] primer-index-1 primer-index-2 primer-index-3 primer-index-4 ...</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;Input Options Description</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; -i (Required) Input BAM file run through `ivar trim` command whcih adds the primer number to BAM auxillary data</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;Output Options Description</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; -p (Required) Prefix, prefix for the filtered BAM file</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;```</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;Example Usage:</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;```</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;```</div></div><!-- fragment --></div><!-- contents -->
69 <!-- start footer part -->
70 <hr class="footer"/><address class="footer"><small>
71 Generated by &#160;<a href="http://www.doxygen.org/index.html">
72 <img class="footer" src="doxygen.png" alt="doxygen"/>
73 </a> 1.8.14
74 </small></address>
75 </body>
76 </html>