<<

NAME

rm_chim - filter out chimeric reads based on alignment against a reference sequence

SYNOPSIS

rm_chim [options] --fq raw_reads --db BWA_database

DESCRIPTION

rm_chim aims to filter out chimeric reads that appear to be techinical artifacts related to certain library preparation protocols. It does this by the simplistic technique of mapping against a known reference sequence and removing reads for which subsequences map in opposite orientations against the genome.

IMPORTANT: Do not use this filter on data where genomic inversions might be expected to actually occur in yoru data.

OPTIONS

Mandatory

--fq fastq

Path to raw data in FASTQ format

--db bwa_prefix

Prefix of BWA database to map against. Either this or --fa must be specified.

--fa fasta

Path to reference FASTA. Either this or --db must be specified.

Optional

--out filename

Specify where to write passed reads to. Default: STDOUT.

--threads integer

Number of threads BWA should use. Default: 1.

--seed integer

Seed to pass to BWA (--k) (for deterministic mapping)

--min_score integer

Minimum BWA alignment score to report (--T). Default: 20.

--help

Display this usage page

--version

Print version information

CAVEATS AND BUGS

Please submit bug reports to the issue tracker in the distribution repository.

AUTHOR

Jeremy Volkening (jeremy.volkening@base2bio.com)

COPYRIGHT AND LICENSE

Copyright 2014-23 Jeremy Volkening

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

<<