Last data update: 2014.03.03

R: Insert sizes histogram
insert.size.histR Documentation

Insert sizes histogram

Description

Computes read pair insert sizes, i.e. distance from first base of first read to last base of second read of a read pair, and plots a histogram for all insert sizes.

Usage

insert.size.hist(readpairs, returnInserts = FALSE, legendpos="topleft", outline=FALSE, main, xlab, ylab, breaks, col, ...)

Arguments

readpairs

RangedData table containing positions of read pairs, i.e. output of reads2pairs (or the element readpairs from the reads2pairs output in case single reads without matching pair were found).

returnInserts

if TRUE, the vector of read pair insert sizes is returned

legendpos

position of the legend, e.g. 'topleft' or 'topright'

outline

if FALSE, outliers (according to boxplot.stats) are removed before plotting. If returnInserts=TRUE, those outliers are still included in the output.

main

plot title

xlab, ylab

x- and y-axis labels

breaks

e.g. integer specifying the number of cells for the histogram, see ?hist

col

histogram color

...

further graphical parameters passed to hist

Value

Histogram of read pair insert sizes. Average, standard deviation and median insert size are given in the legend and indicated by lines.

If returnInserts = TRUE, a named vector of insert sizes is returned.

Author(s)

Manuela Hummel m.hummel@dkfz.de

See Also

get.reads, reads2pairs, duplicates.barplot

Examples

## get reads
exptPath <- system.file("extdata", package="TEQC")
readsfile <- file.path(exptPath, "ExampleSet_Reads.bed")
reads <- get.reads(readsfile, idcol=4, skip=0)

## merge to read pairs
readpairs <- reads2pairs(reads)

## insert size histogram
insert.size.hist(readpairs, breaks=10)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(TEQC)
Loading required package: BiocGenerics
Loading required package: parallel

Attaching package: 'BiocGenerics'

The following objects are masked from 'package:parallel':

    clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,
    clusterExport, clusterMap, parApply, parCapply, parLapply,
    parLapplyLB, parRapply, parSapply, parSapplyLB

The following objects are masked from 'package:stats':

    IQR, mad, xtabs

The following objects are masked from 'package:base':

    Filter, Find, Map, Position, Reduce, anyDuplicated, append,
    as.data.frame, cbind, colnames, do.call, duplicated, eval, evalq,
    get, grep, grepl, intersect, is.unsorted, lapply, lengths, mapply,
    match, mget, order, paste, pmax, pmax.int, pmin, pmin.int, rank,
    rbind, rownames, sapply, setdiff, sort, table, tapply, union,
    unique, unsplit

Loading required package: IRanges
Loading required package: S4Vectors
Loading required package: stats4

Attaching package: 'S4Vectors'

The following objects are masked from 'package:base':

    colMeans, colSums, expand.grid, rowMeans, rowSums

Loading required package: Rsamtools
Loading required package: GenomeInfoDb
Loading required package: GenomicRanges
Loading required package: Biostrings
Loading required package: XVector
Loading required package: hwriter
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/TEQC/insert.size.hist.Rd_%03d_medium.png", width=480, height=480)
> ### Name: insert.size.hist
> ### Title: Insert sizes histogram
> ### Aliases: insert.size.hist
> ### Keywords: hplot
> 
> ### ** Examples
> 
> ## get reads
> exptPath <- system.file("extdata", package="TEQC")
> readsfile <- file.path(exptPath, "ExampleSet_Reads.bed")
> reads <- get.reads(readsfile, idcol=4, skip=0)
[1] "read 19546 sequenced reads"
> 
> ## merge to read pairs
> readpairs <- reads2pairs(reads)
> 
> ## insert size histogram
> insert.size.hist(readpairs, breaks=10)
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>