pedtools (version 2.9.0)

getMap: Tabulate marker positions

Description

Return a map of the markers attached to a pedigree.

Usage

getMap(x, markers = NULL, na.action = 0, merlin = FALSE, verbose = TRUE)
setMap(x, map, matchNames = NA, ...)
hasLinkedMarkers(x)

Value

getMap() returns a data frame with columns CHROM, MARKER and MB.

setMap() returns x with modified marker attributes.

hasLinkedMarkers() returns TRUE if two markers are located (with set position) on the same chromosome, and FALSE otherwise.

Arguments

x

An object of class ped or a list of such.

markers

A vector of names or indices referring to markers attached to x. By default, all markers are included.

na.action

Either 0 (default), 1 or 2. (See Details.)

merlin

A logical mostly for internal use: If TRUE the function returns a matrix instead of a data frame.

verbose

A logical.

map

Either a data frame, the path to a map file, or NULL (for removing map info). See Details regarding format.

matchNames

A logical; if TRUE, pre-existing marker names of x will be used to assign chromosome labels and positions from map.

...

Further arguments passed to read.table().

Details

The na.action argument controls how missing values are dealt with:

• na.action = 0: Return map unmodified

• na.action = 1: Replace missing values with dummy values.

• na.action = 2: Remove markers with missing data.

In setMap(), the map argument should be a data frame (or file) with the following columns in order:

1. chromosome

2. marker name

3. position (Mb)

Column names are ignored, as are any columns after the first three.

Examples

x = singleton(1) |>
  addMarker(chrom = 1, posMb = 10, name = "m1") |>
  addMarker(chrom = 1, posMb = 11) |>
  addMarker(chrom = 1)

# Compare effect of `na.action`
# \donttest{
getMap(x, na.action = 0)
getMap(x, na.action = 1)
getMap(x, na.action = 2)
# }

# Getting and setting map are inverses
y = setMap(x, getMap(x))
stopifnot(identical(x,y))

hasLinkedMarkers(x)