InputVcf: Generate a list of GRanges objects from a VCF file.

Description Usage Arguments Details Value Author(s) Examples

View source: R/InputVcf.R

Description

The InputVcf() function generates a list of GRanges object from a single VCF file.

Usage

1
  InputVcf(vcfFile, ...)

Arguments

vcfFile

a character contains the path and name of a VCF file

...

additional arguments

Details

Read all fields in a VCF file into GRanges object.

Value

a list of GRanges object containing a representation of data from the VCF file

Author(s)

Xiaojing Wang

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## multiple samples in one VCF file

vcffile <- system.file("extdata", "test_mul.vcf", package="customProDB")
vcfs <- InputVcf(vcffile)
length(vcfs)

## single sample

vcffile <- system.file("extdata/vcfs", "test1.vcf", package="customProDB")
vcf <- InputVcf(vcffile)
length(vcf)

customProDB documentation built on Nov. 8, 2020, 8:06 p.m.