validSam: Return a logical vector indicating which are valid samples.

In tomoyukif/GBScleanR: Error correction tool for noisy genotyping by sequencing (GBS) data

Return a logical vector indicating which are valid samples.

Description

Return a logical vector indicating which are valid samples.

Usage

validSam(object, parents = FALSE, ...)

validSam(object) <- value

## S4 method for signature 'GbsrGenotypeData'
validSam(object, parents)

## S4 replacement method for signature 'GbsrGenotypeData'
validSam(object) <- value

Arguments

object	A GbsrGenotypeData object.
parents	A logical value to indicate to set FALSE or TRUE to parental samples. If you specify parents = "only", this function returns a logical vector indicating TRUE for only parental samples.
...	Unused.
value	A logical vector indicating valid samples with the length matching with the number of samples

Value

A logical vector of the same length with the number of total samples.

Examples

# Load data in the GDS file and instantiate a [GbsrGenotypeData] object.
gds_fn <- system.file("extdata", "sample.gds", package = "GBScleanR")
gds <- loadGDS(gds_fn)

validSam(gds)

# Close the connection the GDS file.
closeGDS(gds)

tomoyukif/GBScleanR documentation built on April 27, 2024, 9:06 a.m.