getSampleNames-methods: Get sample names.

Description Usage Arguments Value See Also

Description

Get names of the specified samples. Samples can be specified at one of the following levels: sample, strain, or tetrad. If none are specified, all sample names are returned.

Usage

1
2
3
4
5
6
getSampleNames(cross.info, samples = NULL, strains = NULL, tetrads = NULL,
  simplify = FALSE)

## S4 method for signature 'CrossInfo'
getSampleNames(cross.info, samples = NULL,
  strains = NULL, tetrads = NULL, simplify = FALSE)

Arguments

cross.info

A CrossInfo object.

samples

Vector indicating samples to consider. This may be a logical vector of samples, an integer vector of sample indices, or a character vector that contains sample IDs or their equivalent syntactically valid name.

strains

Vector indicating strains to consider. This may be a logical vector of strains, an integer vector of strain indices, or a character vector that contains strain IDs or their equivalent syntactically valid name.

tetrads

Vector indicating tetrads to consider. This may be a logical vector of tetrads, or an integer vector of tetrad indices.

simplify

Simplify list return value to a vector.

Value

If samples are specified by strain or tetrad, and if the option simplify is not TRUE, this method returns a list of character vectors, each containing the sample names corresponding to a given strain/tetrad. Otherwise, a vector of sample names is returned.

See Also

Other CrossInfo methods: getAlleles, getCrosstype, getGenotypes, getMarkerIndices, getMarkerNames, getMarkerSeqs, getMarkers, getNumMarkers, getNumPhenotypes, getNumSamples, getNumSeqs, getPhenotypeIndices, getPhenotypeNames, getPhenotypes, getSampleIndices, getSamples, getSeqIndices, getSeqMarkers, getSeqNames, getSequences, getStrainIndices, getTetradIndices, hasMarkerSeqs, hasSampleIDs, hasStrainIndices, hasTetradIndices, setAlleles, setCrosstype, setGenotypes, setMarkerSeqs, setMarkers, setPhenotypes, setSamples, setSequences, setStrainIndices, setTetradIndices


gact/shmootl documentation built on Nov. 11, 2021, 6:23 p.m.