validateMapUnit: Validate map unit.

Description Usage Arguments Value Map Units

View source: R/map.R

Description

Validate map unit.

Usage

1
2
3
4
5
6
7
validateMapUnit(x, map.type = NULL)

## S3 method for class 'character'
validateMapUnit(x, map.type = NULL)

## Default S3 method:
validateMapUnit(x, map.type = NULL)

Arguments

x

Map unit, or object with a 'map.unit' attribute.

map.type

Map type for which map unit should be validated. If not specified, map unit is validated for all map types.

Value

TRUE if the specified map unit is a valid map unit for the given map type(s); otherwise, returns error.

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).


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