---

title: bamfilter


keywords: fastai
sidebar: home_sidebar



nb_path: "10_utils_bamfilter.ipynb"
---
<!--

#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: 10_utils_bamfilter.ipynb
# command to build the docs after a change: nbdev_build_docs

-->

<div class="container" id="notebook-container">
        
    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h4 id="filter_bam_by_name" class="doc_header"><code>filter_bam_by_name</code><a href="https://github.com/btrspg/simplebitk/tree/master/simplebitk/utils/bamfilter.py#L11" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>filter_bam_by_name</code>(<strong><code>read_name_list</code></strong>, <strong><code>bamfile</code></strong>, <strong><code>output</code></strong>, <strong><code>included</code></strong>=<em><code>True</code></em>)</p>
</blockquote>
<p>Filter the bam by read name</p>
<p>:param str read_name_list: read name list, could be names include or exclude
:param str bamfile: bam
:param str output: output bam file
:param bool included: whether the read names in the read name list should be included in the output bamfile or excluded in the output bamfile</p>

</div>

</div>

</div>
</div>

</div>
    {% endraw %}

    {% raw %}
    
<div class="cell border-box-sizing code_cell rendered">

</div>
    {% endraw %}

</div>