get_position_reads: get_position_reads

Description Usage Arguments Value Author(s)

Description

Produces a list of all the reads (CIGAR string and position) from a BAM file which overlap a certain chromosome and position, and whose CIGAR string contains a classification of the specified operation.

Usage

1
get_position_reads(bam_file = NULL, chr = NULL, position = NULL, operation = "S", offsets = NULL)

Arguments

bam_file

Path directory to where an aligned BAM file is, containing aligned reads in the correct format (required).

chr

String or character of the chromosome to be focused on, (e.g. "1", 1, "X") (required).

position

Number representing the location within the chromosome. Reads which overlap this position on the given chromosome will be returned (required).

operation

Character of either one of: M, I, D, N, S, H, P, =, or X, representing the available operations within a CIGAR string. This parameter will determine which overlapping reads will be returned, if they contain this operation. If "H", then the entire read will be classified as hard clipped, not just the portion from the cigar string (default "S" for soft clippings).

offsets

Positive integer dictating interval to the right of the position in which to access all reads from the BAM file (required).

Value

Returns a data frame containing a unique subset of the reads which overlap the given position and chromosome> The subset of the location's reads is specified by whether the read contains the CIGAR string operation, and whether that operation surrounds the given position.

Author(s)

L. Christine Schreiner


shlienlab/ShlienLab.Core.Filter documentation built on May 20, 2019, 5:27 p.m.