filters: Report on filters used on a snpRdata object.

In hemstrow/snpR: Whole-Genome Analysis Tools for Use with Single Nucleotide Polymorphism Data

Report on filters used on a snpRdata object.

Description

snpR will automatically track the methods used on a snpRdata object. Using filters on that object will provide details on the the filters used.

Usage

filters(x)

Arguments

x	snpRdata object

Details

Printed outputs contain the filters used in the order they were applied alongside the filtering stringency and any facets applied over, if applicable. Note that some output formats from format_snps, like the vcf format, will notes on the filters used as well.

Value

Prints easily human readable results to the console and also returns a more machine readable string.

Author(s)

William Hemstrom

Examples

# filter the data
x <- filter_snps(stickSNPs, 
                 min_ind = 0.75, 
                 min_loci = 0.75,
                 maf = 0.1,
                 maf_facets = "pop")

# fetch the filters used
filters(x)

hemstrow/snpR documentation built on March 20, 2024, 7:03 a.m.