isStructural: Determining whether the variant is a structural variant

Description Usage Arguments Details Value Methods (by class) Examples

Description

Determining whether the variant is a structural variant

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
isStructural(x, ...)

## S4 method for signature 'CollapsedVCF'
isStructural(x, ..., singleAltOnly = TRUE)

## S4 method for signature 'ExpandedVCF'
isStructural(x, ...)

## S4 method for signature 'VCF'
isStructural(x, ...)

Arguments

x

A VCF object.

...

Internal parameters.

singleAltOnly

Whether only single ALT values are accepted. Default is set to TRUE.

Details

The function takes a VCF object as input, and returns a logical value for each row, determining whether the variant is a structural variant.

Value

A logical list of which the length is the same with the input object.

Methods (by class)

Examples

1
2
3
vcf.file <- system.file("extdata", "gridss.vcf", package = "StructuralVariantAnnotation")
vcf <- VariantAnnotation::readVcf(vcf.file, "hg19")
isStructural(vcf)

d-cameron/StructuralVariantAnnotation documentation built on Dec. 26, 2021, 6:14 p.m.