filter_vcf_query_samples: Filter VCF query samples

View source: R/filter_vcf_samples.R

filter_vcf_query_samplesR Documentation

Filter VCF query samples

Description

Only include certain samples in a VCF query. If at least one sample is supplied, returns a ScanVcfParam. Otherwise, returns the original GRanges object (gr).

Usage

filter_vcf_query_samples(gr, samples = character(), verbose = TRUE)

Arguments

gr

A GRanges object generated by construct_query.

samples

[Optional] Sample names to subset the VCF by. If this option is used, the GRanges object will be converted to a ScanVcfParam for usage by readVcf.

verbose

Print messages.

Value

GRanges or ScanVcfParam object.


RajLabMSSM/echotabix documentation built on Nov. 21, 2023, 8:02 a.m.