check_cross2: Check a cross2 object

Description Usage Arguments Details Value Examples

View source: R/check_cross2.R

Description

Check the integrity of the data within a cross2 object.

Usage

1
check_cross2(cross2)

Arguments

cross2

An object of class "cross2", as output by read_cross2(). For details, see the R/qtl2 developer guide.

Details

Checks whether a cross2 object meets the specifications. Problems are issued as warnings.

Value

If everything is correct, returns TRUE; otherwise FALSE, with attributes that give the problems.

Examples

1
2
grav2 <- read_cross2(system.file("extdata", "grav2.zip", package="qtl2"))
check_cross2(grav2)

qtl2 documentation built on Oct. 18, 2021, 1:06 a.m.