nsam: Return the number of samples.

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

Return the number of samples.

Description

This function returns the number of samples recorded in the GDS file connected to the given GbsrGenotypeData object.

Usage

nsam(object, valid = TRUE, parents = FALSE, ...)

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

Arguments

object	A GbsrGenotypeData object.
valid	A logical value. See details.
parents	A logical value whether to include to parental samples or not.
...	Unused.

Details

If valid = TRUE, the number of the samples which are labeled TRUE in the "valid" column of the "sample" slot will be returned. If you need the number of over all samples, set valid = FALSE. validSam() tells you which samples are valid.

Value

An integer value to indicate the number of samples.

See Also

validSam()

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)

nsam(gds)

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

tomoyukif/GBScleanR documentation built on Oct. 31, 2024, 2:43 a.m.