setMapUnit: Set map unit.

Description Usage Arguments Value Map Units See Also

View source: R/map.R

Description

Set the map unit of the object. If the object already has a map unit, map positions are rescaled from the original map unit to the new map unit. If a data.frame contains map unit information in headings or map positions, these are updated to reflect the new map unit.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
setMapUnit(x, map.unit)

## S3 method for class 'data.frame'
setMapUnit(x, map.unit)

## S3 method for class 'list'
setMapUnit(x, map.unit)

## S3 method for class 'map'
setMapUnit(x, map.unit)

## S3 method for class 'mapframe'
setMapUnit(x, map.unit)

Arguments

x

Object containing map data.

map.unit

Map unit.

Value

Input object with the specified map unit.

Map Units

A map or mapframe must express positions in either genetic or physical map units. Genetic map positions must be in centiMorgans (cM), while physical map positions must be in base pairs (bp), kilobases (kb), or Megabases (Mb).

See Also

Other map utility functions: as.data.frame.mapframe, as.data.frame.map, as.mapframe, as.map, extractMarkers, extractPseudomarkers, findFlanking, findLoci, findMarkers, getMapSteps, getMapUnit, gmapframe, hasMapCSV, inMapOrder, inferMapStep, mapframe, mapsEqual, orderMap, readMapCSV, readMapHDF5, readMapframeCSV, writeMapCSV, writeMapHDF5, writeMapframeCSV


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