File: StructuralVariantAnnotation.Rd

package info (click to toggle)
r-bioc-structuralvariantannotation 1.13.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,568 kB
  • sloc: makefile: 2
file content (23 lines) | stat: -rw-r--r-- 1,065 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/StructuralVariantAnnotation.R
\docType{package}
\name{StructuralVariantAnnotation}
\alias{StructuralVariantAnnotation}
\title{StructuralVariantAnnotation: a package for SV annotation}
\description{
StructuralVariantAnnotation contains useful helper functions for reading
and interpreting structural variants calls. The packages contains functions
for parsing VCFs from a number of popular caller as well as functions for
dealing with breakpoints involving two separate genomic loci. The package
takes a `GRanges` based breakend-centric approach.
}
\details{
* Parse VCF objects with the `breakpointRanges()` and `breakendRanges()`functions.
   * Find breakpoint overlaps with the `findBreakpointOverlaps()`
  and `countBreakpointOverlaps()` functions.
   * Generate BEDPE files for circos plot with `breakpointgr2pairs()` function.
   * ...

For more details on the features of StructuralVariantAnnotation, read the vignette:
`browseVignettes(package = "StructuralVariantAnnotation")`
}