Skip to content

Commit b7e8b61

Browse files
committed
Updated documentation. Removed awk dependency.
1 parent b9dd527 commit b7e8b61

File tree

14 files changed

+212
-112
lines changed

14 files changed

+212
-112
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ bioRxiv doi: [https://doi.org/10.1101/383513](https://doi.org/10.1101/383513)
2121
### Dependencies
2222

2323
* [HTSlib](http://www.htslib.org/download/)
24-
* [Awk](https://www.cs.princeton.edu/~bwk/btl.mirror/) - Pre-installed on most UNIX systems.
2524
* [GCC](https://gcc.gnu.org/) any version after v5.0. Support for C++11 standard required.
2625

2726
Note:

docs/INSTALLATION.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ Installation {#installpage}
66
### Dependencies
77

88
* [HTSlib](http://www.htslib.org/download/)
9-
* [Awk](https://www.cs.princeton.edu/~bwk/btl.mirror/) - Pre-installed on most UNIX systems.
109
* [GCC](https://gcc.gnu.org/) any version after v5.0. Support for c++11 standard required.
1110

1211
Note:

docs/MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Puerto 1054 1076 400_3_out_R* 60 -
7979
Call variants with iVar
8080
----
8181

82-
iVar uses the output of the `samtools mpileup` command to call variants - single nucleotide variants(SNVs) and indels. In order to call variants correctly, the reference file used for alignment must be passed to iVar using the `-r` flag. The output of `samtools pileup` is piped into `ivar variants` to generate a .tsv file with the variants. There are two parameters that can be set for variant calling using iVar - minimum quality(Default: 20) and minimum frequency(Default: 0.03). Minimum quality is the minimum quality for a base to be counted towards the ungapped depth to canculate iSNV frequency at a given position. For insertions, the quality metric is discarded and the mpileup depth is used directly. Minimum frequency is the minimum frequency required for a SNV or indel to be reported. iVar can also identify codons and translate variants into amino acids using a GFF file in the [GFF3](https://github.com/The-Sequence-Ontology/Specifications/blob/master/gff3.md) format containing the required coding regions (CDS). In absence of a GFF file, iVar will not perform the translation and "NA" will be added to the output file in place of the reference and alternate codons and amino acids.
82+
iVar uses the output of the `samtools mpileup` command to call variants - single nucleotide variants(SNVs) and indels. In order to call variants correctly, the reference file used for alignment must be passed to iVar using the `-r` flag. The output of `samtools pileup` is piped into `ivar variants` to generate a .tsv file with the variants. There are two parameters that can be set for variant calling using iVar - minimum quality(Default: 20) and minimum frequency(Default: 0.03). Minimum quality is the minimum quality for a base to be counted towards the ungapped depth to canculate iSNV frequency at a given position. For insertions, the quality metric is discarded and the mpileup depth is used directly. Minimum frequency is the minimum frequency required for a SNV or indel to be reported. iVar can also identify codons and translate variants into amino acids using a GFF file in the [GFF3](https://github.com/The-Sequence-Ontology/Specifications/blob/master/gff3.md) format containing the required coding regions (CDS). In absence of a GFF file, iVar will not perform the translation and "NA" will be added to the output file in place of the reference and alternate codons and amino acids. The GFF file in the GFF3 format can be downloaded via ftp from NCBI RefSeq/Genbank. They are usually the files with the extension ".gff.gz". For example, the GFF file for Zaire Ebolavirus can be found [here](ftp://ftp.ncbi.nlm.nih.gov/genomes/refseq/viral/Zaire_ebolavirus/all_assembly_versions/GCF_000848505.1_ViralProj14703). More details on GFF3 files hosted by NCBI can be found in their ftp [FAQs](https://www.ncbi.nlm.nih.gov/genome/doc/ftpfaq/).
8383

8484
Some RNA viruses such as Ebola virus, might have polymerase slippage causing the insertion of a couple of nucleotides. More details can be found here[https://viralzone.expasy.org/857?outline=all_by_protein]. iVar can account for this editing and identify the correct open reading frames. The user will have to specify two additional parameters: EditPosition and EditSequence in the "attributes" column of the GFF file to account for this. A test example is given here,
8585

docs/html/cookbookpage.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<tr style="height: 56px;">
2727
<td id="projectalign" style="padding-left: 0.5em;">
2828
<div id="projectname">iVar
29+
&#160;<span id="projectnumber">1.1</span>
2930
</div>
3031
</td>
3132
</tr>

docs/html/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<tr style="height: 56px;">
2727
<td id="projectalign" style="padding-left: 0.5em;">
2828
<div id="projectname">iVar
29+
&#160;<span id="projectnumber">1.1</span>
2930
</div>
3031
</td>
3132
</tr>

docs/html/installpage.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<tr style="height: 56px;">
2727
<td id="projectalign" style="padding-left: 0.5em;">
2828
<div id="projectname">iVar
29+
&#160;<span id="projectnumber">1.1</span>
2930
</div>
3031
</td>
3132
</tr>
@@ -90,7 +91,6 @@
9091
<div class="textblock"><h3>Dependencies</h3>
9192
<ul>
9293
<li><a href="http://www.htslib.org/download/">HTSlib</a></li>
93-
<li><a href="https://www.cs.princeton.edu/~bwk/btl.mirror/">Awk</a> - Pre-installed on most UNIX systems.</li>
9494
<li><a href="https://gcc.gnu.org/">GCC</a> any version after v5.0. Support for c++11 standard required.</li>
9595
</ul>
9696
<p>Note:</p><ul>

0 commit comments

Comments
 (0)