Difference between revisions of "MOSAIK"

From UFRC
Jump to navigation Jump to search
m (Text replacement - "#uppercase" to "uc")
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
[[Category:Software]][[Category:Biology]][[Category:Bioinformatics]][[Category:Short Read Alignment]]
+
__NOTOC__
−
{|<!--CONFIGURATION: REQUIRED-->
+
__NOEDITSECTION__
 +
[[Category:Software]][[Category:Biology]][[Category:Alignment]]
 +
{|<!--Main settings - REQUIRED-->
 
|{{#vardefine:app|mosaik}}
 
|{{#vardefine:app|mosaik}}
−
|{{#vardefine:url|https://code.google.com/archive/p/mosaik-aligner/}}
+
|{{#vardefine:url|http://code.google.com/p/mosaik-aligner/}}
−
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
+
|{{#vardefine:exe|1}} <!--Present manual instructions for running the software -->
−
|{{#vardefine:conf|}}           <!--CONFIGURATION-->
+
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
−
|{{#vardefine:exe|}}           <!--ADDITIONAL INFO-->
+
|{{#vardefine:pbs|}} <!--Enable PBS script wiki page link-->
−
|{{#vardefine:job|}}           <!--JOB SCRIPTS-->
+
|{{#vardefine:policy|}} <!--Enable policy section -->
−
|{{#vardefine:policy|}}         <!--POLICY-->
+
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
−
|{{#vardefine:testing|}}       <!--PROFILING-->
+
|{{#vardefine:faq|}} <!--Enable FAQ section -->
−
|{{#vardefine:faq|}}             <!--FAQ-->
+
|{{#vardefine:citation|1}} <!--Enable Reference/Citation section -->
−
|{{#vardefine:citation|1}}       <!--CITATION-->
 
−
|{{#vardefine:installation|}} <!--INSTALLATION-->
 
 
|}
 
|}
−
<!--BODY-->
+
<!-- ########  Template Body ######## -->
 
<!--Description-->
 
<!--Description-->
 
{{#if: {{#var: url}}|
 
{{#if: {{#var: url}}|
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
  
−
MOSAIK is a reference-guided assembler comprising of two main modular programs:
+
MOSAIK is a reference-guided assembler comprising of four main modular programs:
  
−
MosaikBuild
+
* MosaikBuild
−
MosaikAligner
+
* MosaikAligner
−
MosaikBuild converts various sequence formats into Mosaik’s native read format. MosaikAligner pairwise aligns each read to a specified series of reference sequences and produces BAMs as outputs.
+
* MosaikSort
 +
* MosaikText
  
−
At this time, the workflow consists of supplying sequences in FASTA, FASTQ, Illumina Bustard & Gerald, or SRF file formats and producing results in the BAM format.
+
MosaikBuild converts various sequence formats into Mosaik’s native read format. MosaikAligner pairwise aligns each read to a specified series of reference sequences. MosaikSort resolves paired-end reads and sorts the alignments by the reference sequence coordinates. Finally, MosaikText converts alignments to different text-based formats.
  
 +
At this time, the workflow consists of supplying sequences in FASTA, FASTQ, Illumina Bustard & Gerald, or SRF file formats and producing results in the BLAT axt, the BAM/SAM, the UCSC Genome Browser bed, or the Illumina ELAND formats.
 
<!--Modules-->
 
<!--Modules-->
 
==Environment Modules==
 
==Environment Modules==
Line 31: Line 33:
 
==System Variables==
 
==System Variables==
 
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
 
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
−
* HPC_{{uc:{{#var:app}}}}_BIN - executable directory
+
* HPC_MOSAIK_BIN - executable file directory.
−
* HPC_{{uc:{{#var:app}}}}_NET - network file directory
+
* HPC_MOSAIK_NET - network file directory.
−
* MOSAIK_TMP - directory for temporary files
+
* MOSAIK_TMP - default temporary file directory. Note that HiPerGator2 nodes are diskless, so MOSAIK_TMP must not be set to /tmp.
−
 
+
{{#if: {{#var: exe}}|==How To Run==
−
<!--Configuration-->
+
If you would like to use the provided network files with MosaikAligner use the $HPC_MOSAIK_NET variable for the location of network file directory. E.g.
 +
MosaikAligner -annpe $HPC_MOSAIK_NET/2.1.26.pe.100.0065.ann \
 +
-annse $HPC_MOSAIK_NET/2.1.26.se.100.005.ann -in ...
 +
|}}
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==
−
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
+
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}}
−
|}}
+
{{#if: {{#var: pbs}}|==PBS Script Examples==
−
<!--Run-->
+
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
−
{{#if: {{#var: exe}}|==Additional Information==
 
−
 
 
−
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
 
−
 
 
−
|}}
 
−
<!--Job Scripts-->
 
−
{{#if: {{#var: job}}|==Job Script Examples==
 
−
See the [[{{PAGENAME}}_Job_Scripts]] page for {{#var: app}} Job script examples.
 
−
|}}
 
−
<!--Policy-->
 
 
{{#if: {{#var: policy}}|==Usage Policy==
 
{{#if: {{#var: policy}}|==Usage Policy==
−
 
+
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}
−
WRITE USAGE POLICY HERE (Licensing, usage, access).
 
−
 
 
−
|}}
 
−
<!--Performance-->
 
 
{{#if: {{#var: testing}}|==Performance==
 
{{#if: {{#var: testing}}|==Performance==
−
 
+
WRITE PERFORMANCE TESTING RESULTS HERE|}}
−
WRITE_PERFORMANCE_TESTING_RESULTS_HERE
 
−
 
 
−
|}}
 
−
<!--Faq-->
 
 
{{#if: {{#var: faq}}|==FAQ==
 
{{#if: {{#var: faq}}|==FAQ==
 
*'''Q:''' **'''A:'''|}}
 
*'''Q:''' **'''A:'''|}}
−
<!--Citation-->
 
 
{{#if: {{#var: citation}}|==Citation==
 
{{#if: {{#var: citation}}|==Citation==
−
If you publish research that uses {{#var:app}} you have to cite it as follows:
+
If you publish research that uses {{{app}}} you have to cite it as follows:
  
 
[http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0090581 http://dx.plos.org/10.1371/journal.pone.0090581]
 
[http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0090581 http://dx.plos.org/10.1371/journal.pone.0090581]
−
 
 
|}}
 
|}}
−
<!--Installation-->
 
−
{{#if: {{#var: installation}}|==Installation==
 
−
See the [[{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
 
−
<!--Turn the Table of Contents and Edit paragraph links ON/OFF-->
 
−
__NOTOC____NOEDITSECTION__
 

Latest revision as of 11:59, 19 August 2022

Description

mosaik website  

MOSAIK is a reference-guided assembler comprising of four main modular programs:

  • MosaikBuild
  • MosaikAligner
  • MosaikSort
  • MosaikText

MosaikBuild converts various sequence formats into Mosaik’s native read format. MosaikAligner pairwise aligns each read to a specified series of reference sequences. MosaikSort resolves paired-end reads and sorts the alignments by the reference sequence coordinates. Finally, MosaikText converts alignments to different text-based formats.

At this time, the workflow consists of supplying sequences in FASTA, FASTQ, Illumina Bustard & Gerald, or SRF file formats and producing results in the BLAT axt, the BAM/SAM, the UCSC Genome Browser bed, or the Illumina ELAND formats.

Environment Modules

Run module spider mosaik to find out what environment modules are available for this application.

System Variables

  • HPC_MOSAIK_DIR - installation directory
  • HPC_MOSAIK_BIN - executable file directory.
  • HPC_MOSAIK_NET - network file directory.
  • MOSAIK_TMP - default temporary file directory. Note that HiPerGator2 nodes are diskless, so MOSAIK_TMP must not be set to /tmp.

How To Run

If you would like to use the provided network files with MosaikAligner use the $HPC_MOSAIK_NET variable for the location of network file directory. E.g. 

MosaikAligner -annpe $HPC_MOSAIK_NET/2.1.26.pe.100.0065.ann \
-annse $HPC_MOSAIK_NET/2.1.26.se.100.005.ann -in ...



Citation

If you publish research that uses {{{app}}} you have to cite it as follows:

http://dx.plos.org/10.1371/journal.pone.0090581

Retrieved from "https://help.rc.ufl.edu/mediawiki/index.php?title=MOSAIK&oldid=25509"