svc.break.annot: Identify recurrently altered genes by structural variants....

In gonzolgarcia/svpluscnv: Integrative analyses of CNV segmentation and SV variant calls

Description

Identify recurrently altered genes by structural variants. The function will identify overlaps between genomic features (e.g. genes) and SVs breakpoints.

Usage

svc.break.annot(
  svc,
  genome.v = "hg19",
  genesgr = NULL,
  upstr = 50000,
  dnstr = 50000,
  svc.seg.size = 2e+05,
  verbose = TRUE
)

Arguments

svc	(S4) an object of class svcnvio containing data type 'svc' validated by validate.svc
genome.v	(character): either 'hg19' or 'hg38' accepted; reference genome version to retrieve gene annotations including genomic coordinates and strand
genesgr	(S4) a GenomicRanges object containing gene annotations (if not NULL overides genome.v). It is crutial that the genome version 'genesgr' and the input 'sv' are the same. The GRanges object must contain 'strand' and a metadata field 'gene_id' with unique values. Seqnames are expected in the format (chr1, chr2, ...).
upstr	(numeric) size in base pairs to define gene upstream region onto which breakpoint overlaps will be identified. The strand value, start and stop positions defined in genesgr will be used to create a GRanges object of upstream regions.
dnstr	(numeric) size in base pairs to define gene downstream region onto which breakpoint overlaps will be identified. The strand value, start and stop positions defined in genesgr will be used to create a GRanges object of downstream regions.
svc.seg.size	(numeric) base pairs for maximum allowed segmental variants (DEL, DUP, INV or INS) size. Larger segmental SVs are treated as translocations and only the breakpoint position will be overlapped with genomic features.

Value

an instance of the class 'break.annot' containing breakpoint mapping onto genes

Examples

## Obtain breakpoints from SV calls data
svc <- validate.svc(svcdat_lung_ccle)

svc.break.annot(svc, genome.v="hg19")

gonzolgarcia/svpluscnv documentation built on March 4, 2020, 10:06 a.m.