getVariantCoverageTable: Retrieveing variants genomic and alleles count information...

Description Usage Arguments Value Note See Also Examples

Description

This function takes as input a VCF file obtained from an LFR experiment and output and returns of class SampleCoverage containing the genomic and allele count information per sample of each variants.

Usage

1
2
3
getVariantCoverageTable(VCFFilePath, wells_id = NULL, region = NULL,
  OnlyPassFilter = FALSE, FiltersToInclude = NULL,
  FiltersToExclude = NULL)

Arguments

VCFFilePath

A character string representing the path to a VCF file obtained from an LFR experiment study. The file should contains one genotype information column per well sample.

wells_id

A vector of character string representing the well sample ID to assign to the columns name corresponding to each sample genotyping information. If not provided the column names in the VCF file are maintained. length(well_id) should be equal to the number of column of the VCF file - 9 following to the VCF format specifications.

region

A character string representing the region of the genome to consider given in the following format : 'chrom:start-end'. Default value :NULL and all the variants in the VCF file will be considered.

OnlyPassFilter

A logical value. If set to true, only the variant having their calling filter status set at 'PASS'

FiltersToInclude

A vector of character string representing a list of calling filter status. All the variant having any of them will be included in the analysis.

FiltersToExclude

A vector of character string representing a list of calling filter status. All the variant having any of them will be excluded from the analysis given that the filte ris not included in FiltersToInclude.

Value

An object of class SampleCoverage.

Note

The function can also be used on a multiple sample and non LFR experiment.

See Also

getVariantAlleleInfo, plot.VariantAlleleInfo, SampleCoverage, VariantAlleleInfo

Examples

1
2
3
 vcffile<-system.file('extdata','LFR_11152_Tissue_chr22.vcf.gz',package='DigitalPicoTools')
 CoverageTable = getVariantCoverageTable(vcffile)
 print(head(CoverageTable))

chedonat/DigitalPicoTools documentation built on May 13, 2019, 3:39 p.m.