getBinAnnotations: Gets bin annotation data for a particular bin size

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/getBinAnnotations.R

Description

Gets bin annotation data for a particular bin size.

Usage

1
2
getBinAnnotations(binSize, genome="hg19", type="SR50",
  path=getOption("QDNAseq::binAnnotationPath", NULL))

Arguments

binSize

A numeric scalar specifying the width of the bins in units of kbp (1000 base pairs), e.g. binSize=15 corresponds to 15 kbp bins.

genome

A character string specify the genome and genome version to be used.

type

A character string specify the experiment type, e.g. "SR50" or "PE100".

path

A character string specifying the path for the bin annotation files. Defaults to downloading from the Internet, but can also be a local path. Can also be defined by setting the QDNAseq::binAnnotationPath option.

Details

Gets bin annotation data for a particular bin size

Value

Returns a AnnotatedDataFrame object.

Author(s)

Ilari Scheinin

See Also

createBins().

Examples

1
2
3
4
## Not run: 
bins <- getBinAnnotations(15)

## End(Not run)

ccagc/QDNAseq documentation built on April 15, 2019, 10:52 a.m.