getMapUnit: Get map unit.

Description Usage Arguments Value Map Units See Also

View source: R/map.R

Description

Get the map unit of the object. In most cases, this is taken from the 'map.unit' attribute of the object. For a data.frame, the position column is also checked for map unit information; an error is raised if data.frame map unit information is inconsistent.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
getMapUnit(x)

## S3 method for class 'data.frame'
getMapUnit(x)

## Default S3 method:
getMapUnit(x)

## S3 method for class 'map'
getMapUnit(x)

## S3 method for class 'mapframe'
getMapUnit(x)

## S3 method for class 'scanone'
getMapUnit(x)

Arguments

x

Object containing map data.

Value

Map unit. Returns NA if map unit information not found.

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, gmapframe, hasMapCSV, inMapOrder, inferMapStep, mapframe, mapsEqual, orderMap, readMapCSV, readMapHDF5, readMapframeCSV, setMapUnit, writeMapCSV, writeMapHDF5, writeMapframeCSV


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