View source for LRBinner

[[Category:Software]]
[[Category:Biology]]
[[Category:genomics]]
{|<!--CONFIGURATION: REQUIRED-->
|{{#vardefine:app|LRBinner}}
|{{#vardefine:url|https://github.com/anuradhawick/LRBinner}}
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
|{{#vardefine:conf|}}           <!--CONFIGURATION-->
|{{#vardefine:exe|}}            <!--ADDITIONAL INFO-->
|{{#vardefine:job|1}}            <!--JOB SCRIPTS-->
|{{#vardefine:policy|}}         <!--POLICY-->
|{{#vardefine:testing|}}       <!--PROFILING-->
|{{#vardefine:faq|}}             <!--FAQ-->
|{{#vardefine:citation|1}}       <!--CITATION-->
|{{#vardefine:installation|}} <!--INSTALLATION-->
|}
<!--BODY-->
<!--Description-->
{{#if: {{#var: url}}|
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}

LRBinner is a long-read binning tool that overcomes several limitations of our previous work MetaBCC-LR (ISMB 2020). The tool uses variational auto-encoders to bin error-prone long reads using coverage and composition. 

<!--Modules-->
==Environment Modules==
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
==System Variables==
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
* HPC_{{uc:{{#var:app}}}}_BIN - executable directory
<!--Configuration-->
{{#if: {{#var: conf}}|==Configuration==
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
|}}
<!--Run-->
{{#if: {{#var: exe}}|==Additional Information==

WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY

|}}
<!--Job Scripts-->
{{#if: {{#var: job}}|==Job Script Examples==
Below is a job script used for testing application installation
<div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;">
''Expand to view example.''
<div class="mw-collapsible-content" style="padding: 5px;">
<pre>
#!/bin/bash
#SBATCH --job-name=lrbinner_0.1_test
#SBATCH --mail-type=NONE
#SBATCH --nodes=1
#SBATCH --ntasks=1
#SBATCH --cpus-per-task=32
#SBATCH --mem-per-cpu=4gb
#SBATCH --partition=gpu
#SBATCH --gres=gpu:a100:1
#SBATCH --time=24:00:00
#SBATCH --output=lrbinner_0.1_test.log

echo "Setting up test environment..."
TEST_PWD=/data/apps/tests/lrbinner/0.1
TEST_DATADIR=${TEST_PWD}/example_data
TEST_WORKDIR=${TEST_PWD}/test_output

cd ${TEST_PWD}
module load lrbinner/0.1

# Remove any previous test results and re-create a working directory
if [ -d ${TEST_WORKDIR} ]; then rm -rf ${TEST_WORKDIR}/; fi
mkdir ${TEST_WORKDIR}

echo "Starting test run at $(date) on $(hostname)..."

# Based on https://github.com/anuradhawick/LRBinner#test-run-data
###################################
LRBinner \
    reads \
    -r ${TEST_DATADIR}/reads.fasta \
    -bc 10 \
    -bs 32 \
    -o ${TEST_WORKDIR}/lrb \
    --cuda \
    -mbs 5000 \
    --ae-dims 4 \
    --ae-epochs 200 \
    -bit 0 \
    -t ${SLURM_JOB_CPUS_PER_NODE:-4}

# Evaluate results:
eval.py \
    --truth ${TEST_DATADIR}/ids.txt \
    --bins ${TEST_WORKDIR}/lrb/bins.txt \
    --print
###################################

echo "Test complete at $(date)."
</pre>
</div>
</div>

|}}
<!--Policy-->
{{#if: {{#var: policy}}|==Usage Policy==

WRITE USAGE POLICY HERE (Licensing, usage, access).

|}}
<!--Performance-->
{{#if: {{#var: testing}}|==Performance==

WRITE_PERFORMANCE_TESTING_RESULTS_HERE

|}}
<!--Faq-->
{{#if: {{#var: faq}}|==FAQ==
*'''Q:''' **'''A:'''|}}
<!--Citation-->
{{#if: {{#var: citation}}|==Citation==
If you publish research that uses {{#var:app}} you have to cite it as follows:

<pre>
 @InProceedings{wickramarachchi_et_al:LIPIcs.WABI.2021.11,
   author =	{Wickramarachchi, Anuradha and Lin, Yu},
   title =	{{LRBinner: Binning Long Reads in Metagenomics Datasets}},
   booktitle =	{21st International Workshop on Algorithms in Bioinformatics (WABI 2021)},
   pages =	{11:1--11:18},
   series =	{Leibniz International Proceedings in Informatics (LIPIcs)},
   ISBN =	{978-3-95977-200-6},
   ISSN =	{1868-8969},
   year =	{2021},
   volume =	{201},
   editor =	{Carbone, Alessandra and El-Kebir, Mohammed},
   publisher =	{Schloss Dagstuhl -- Leibniz-Zentrum f{\"u}r Informatik},
   address =	{Dagstuhl, Germany},
   URL =		{https://drops.dagstuhl.de/opus/volltexte/2021/14364},
   URN =		{urn:nbn:de:0030-drops-143644},
   doi =		{10.4230/LIPIcs.WABI.2021.11},
   annote =	{Keywords: Metagenomics binning, long reads, machine learning, clustering}
 }
</pre>
|}}
<!--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__