remove_matches | R Documentation |
Using the filter_host()
function, we align our sequencing sample to
all filter libraries of interest. The remove_matches()
function allows
for removal of any target reads that are also aligned to filter libraries.
remove_matches(
reads_bam,
read_names,
output,
YS,
threads,
aligner,
make_bam,
quiet
)
reads_bam |
The name of a merged, sorted .bam file that has previously
been aligned to a reference library. Likely, the output from running an
instance of |
read_names |
A |
output |
The name of the .bam or .csv.gz file that to which the filtered alignments will be written. |
YS |
yieldSize, an integer. The number of alignments to be read in from the bam file at once for chunked functions. Default is 100000. |
threads |
The number of threads to be used in filtering the bam file. Default is 1. |
aligner |
The aligner which was used to create the bam file. |
make_bam |
Logical, whether to also output a bam file with host reads
filtered out. A .csv.gz file will be created instead if |
quiet |
Turns off most messages. Default is |
This function is not intended for direct use.
Depending on input make_bam
, either the name of a filtered,
sorted .bam file written to the user's current working directory, or an RDS
file containing a data frame of only requisite information to run
metascope_id()
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.