dimVcf: VCF dimensions

dimVcfR Documentation

VCF dimensions

Description

Return the dimensions of a VCF file, i.e. the number of sites (rows) and samples (columns)

Usage

dimVcf(vcf.file, software = "Rsamtools", genome = "", yieldSize = 10000)

Arguments

vcf.file

path to the VCF file (if the bgzip index doesn't exist in the same directory, it will be created)

software

name of the software with which to obtain the dimension of the file (Rsamtools/grep)

genome

genome identifier (e.g. "VITVI_12x2")

yieldSize

number of records to yield each time the file is read from

Value

vector

Author(s)

Timothee Flutre


timflutre/rutilstimflutre documentation built on Feb. 7, 2024, 8:17 a.m.