File: simpleEventType.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 (27 lines) | stat: -rw-r--r-- 936 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
24
25
26
27
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BreakpointGRanges.R
\name{simpleEventType}
\alias{simpleEventType}
\title{Type of simplest explanation of event. Possible types are:
| Type | Description |
| BND | Single breakend |
| CTX | Interchromosomal translocation |
| INV | Inversion. |
| DUP | Tandem duplication |
| INS | Insertion |
| DEL | Deletion |}
\usage{
simpleEventType(gr, insertionLengthThreshold = 0.5)
}
\arguments{
\item{gr}{breakpoint GRanges object}

\item{insertionLengthThreshold}{portion of inserted bases compared to total event size to be classified as an insertion.
For example, a 5bp deletion with 5 inserted bases will be classified as an INS event.}
}
\value{
Type of simplest explanation of event
}
\description{
Note that both ++ and -- breakpoint will be classified as inversions regardless of whether both breakpoint that consistitute an actual inversion exists or not
}