strumMarker-class: Class '"strumMarker"'

In strum: STRUctural Modeling of Latent Variables for General Pedigree

Description

strumMarker is an S4 class that represents a marker data for a STRUctural Modeling of latent variables for family data.

Objects from the Class

Objects should not be created by calls of the form new("strumMarker", ...) but by the calls to the createStrumMarker function.

Slots

markerFacts:

Object of class "data.frame" containing the SNP information - markerName, chrom, mapPos, minorAllele, majorAllele.

haplotypes:

Object of class "matrix" containing hapmap data.

populationRecombRate:

Numeric value stating the average number of crossovers per cM when simulating founders.

errorRate:

Numeric value stating the probability of a genotype error. If a genotype error occurs, a genotype (other than the true genotype) is selected with uniform probability.

mutationRate:

Numeric value stating the probability that an allele will be mutated before it is passed on. If a mutation occurs, a new allele (not the original allele) is selected with uniform probability.

missingRate:

Numeric value stating the probability of a missing genotype.

coding:

Numeric vector of length three stating the coding of inheritance model. The first element corresponds to the code assigned to the homozygous minor allele. The second element corresponds to the heterozygous genotype. The third element corresponds to the homozygous major allele. The default coding is additive (i.e. coding = c(0, 1, 2)).

returnIBD:

Logical. If TRUE, then the ibd slot in the strumData object, simulated using the returned strumMarker object from this function, will be populated. If FALSE, the ibd slot will be left empty.

intervalIBD:

Numeric value stating the interval that ibd values should be calculated.

Methods

markerFacts

signature(object = "strumMarker"): Accessor function, returns the value of the slot markerFacts.

haplotypes

signature(object = "strumMarker"): Accessor function, returns the value of the slot haplotypes.

populationRecombRate

signature(object = "strumMarker"): Accessor function, returns the value of the slot populationRecombRate.

errorRate

signature(object = "strumMarker"): Accessor function, returns the value of the slot errorRate.

mutationRate

signature(object = "strumMarker"): Accessor function, returns the value of the slot mutationRate.

missingRate

signature(object = "strumMarker"): Accessor function, returns the value of the slot missingRate.

coding

signature(object = "strumMarker"): Accessor function, returns the value of the slot coding.

returnIBD

signature(object = "strumMarker"): Accessor function, returns the value of the slot returnIBD.

intervalIBD

signature(object = "strumMarker"): Accessor function, returns the value of the slot intervalIBD.

show

signature(object = "strumMarker"): Print a summary of the class.

See Also

createStrumMarker, simulateStrumData

Examples

showClass("strumMarker")

strum documentation built on May 2, 2019, 7:03 a.m.