MareyMap-class {MareyBase}R Documentation

Class "MareyMap"

Description

The class holds the physical and genetical positions of a marey map

Objects from the Class

Objects can be created by calls of the form new("MareyMap", ...) or using the function MareyMap(). However, most of the time you can more conveniently use already contructed objects contained in mareymaps (c.f. code examples)

Slots

speciesName:
Object of class "character"
mapName:
Object of class "character" containing the name of the map, usually the name of the chromosome it is mapping.
markerNames:
Object of class "vector" containing the names of the markers of the map.
physicalPositions:
Object of class "vector" containing the physical positions of the markers.
geneticDistances:
Object of class "vector" containing the positions of the markers on the genetic map.
markerValidity:
Object of class "vector" indicating for each marker if it is to be taken into account for interpolations.
interpolations:
Object of class "list" containing the interpolations calculated on the map.

Methods

[
signature(x = "MareyMap"): returns a vector combining marker name, physical position, genetic distance and marker validity for the i th marker
[[<-
signature(x = "MareyMap"): replaces marker name, physical position, genetic distance and marker validity for the i th marker. value must be a vector containing 4 column named "name", "phys", "gen" and "valid".
[[
signature(x = "MareyMap"): returns a vector combining marker name, physical position, genetic distance and marker validity for the i th marker
+
signature(e1 = "MareyMap", e2 = "Interpolation"): adds an interpolation to the map
coerce
signature(from = "MareyMap", to = "data.frame"): convert the Marey map into a data.frame.
coerce
signature(from = "data.frame", to = "MareyMap"): create a MareyMap from a data.frame.
geneticDistances<-
signature(object = "MareyMap"): replace the genetic distance with a new vector.
geneticDistances
signature(object = "MareyMap"): returns the genetic distances of the markers
interpolation<-
signature(object = "MareyMap", inter_name = "character", value = "Interpolation"): replaces the interpolation which name matches inter_name with the content of the parameter value.
interpolation
signature(object = "MareyMap", inter_name = "character"): returns the interpolation which name matches inter_name.
interpolations<-
signature(object = "MareyMap"): replace the list of interpolation with a new list.
interpolations
signature(object = "MareyMap"): returns the list of interpolations.
mapName<-
signature(object = "MareyMap"): replaces the name of the map
mapName
signature(object = "MareyMap"): returns the name of the map
markerNames<-
signature(object = "MareyMap"): replaces the marker names with a new vector of names
markerNames
signature(object = "MareyMap"): returns a vector containing the names of the markers
markerValidity<-
signature(object = "MareyMap"): replaces the marker validities with a new vector
markerValidity
signature(object = "MareyMap"): returns a vector containing information about the validity of the markers
physicalPositions<-
signature(object = "MareyMap"): replaces the vector of physical positions with a new vector
physicalPositions
signature(object = "MareyMap"): returns a vector containing the physical positions of the markers
plot
signature(x = "MareyMap", y = "missing"): plots the map as well as the interpolations (if any)
plotMarkers
signature(object = "MareyMap"): plots only the markers of the map, without plotting the interpolations
plotModels
signature(object = "MareyMap"): plot only the models of the interpolations
plotRates
signature(object = "MareyMap"): plots only the recombination rates
speciesName<-
signature(object = "MareyMap", value = "ANY"): replaces the name of the species with a new character.
speciesName
signature(object = "MareyMap"): returns the name of the species.
validPositions
signature(object = "MareyMap"):

Warning

vectors markerNames, physicalPositions, geneticDistances and markerValidity must always retain the same length.

Author(s)

Clement Rezvoy <rezvoy@biomserv.univ-lyon1.fr>

See Also

MapCollection-class SpeciesMaps-class

Examples

data(mareymaps)
chr7 <- mareymaps[["Homo sapiens (deCODE)","Chromosome 07"]]
mapName(chr7) <- "chr7"
speciesName(chr7) <- "Human"
plot(chr7)
plotMarkers(chr7)

[Package MareyBase version 0.9 Index]