setPosColNameMapUnit: Set map unit of position column heading.

Description Usage Arguments Value Map Units

View source: R/map.R

Description

Set map unit of position column heading.

Usage

1
2
3
4
5
6
7
setPosColNameMapUnit(x, map.unit)

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

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

Arguments

x

A mapframe or equivalent data.frame, or a position column heading.

map.unit

Map unit. Set to NULL to remove map unit information from position column heading.

Value

Input object with the specified map unit added to position column heading.

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.