validateMap: Validate 'map' object.

Description Usage Arguments Value Map

View source: R/map.R

Description

Validate map object.

Usage

1
2
3
4
5
6
7
validateMap(x, ...)

## S3 method for class 'list'
validateMap(x)

## S3 method for class 'map'
validateMap(x, package = c("qtl", "shmootl"))

Arguments

x

A map or equivalent list.

Value

TRUE if object is a valid map or equivalent list; otherwise, returns first error.

Map

The R/qtl map object - described in detail in Section 2.6 of Broman and Sen (2009) - comprises a nonempty list, each element of which contains two or more marker positions for a given chromosome. Each list element is named for its corresponding chromosome, while the names of each chromosome's marker position vector comprise the marker locus IDs.

Within shmootl, a map must represent either a genetic or a physical map. These are distinguished by the 'map.unit' attribute of an object, which can contain either genetic or physical map units.


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