read_cross2: Read QTL data from files

Description Usage Arguments Details Value See Also Examples

View source: R/read_cross2.R

Description

Read QTL data from a set of files

Usage

1
read_cross2(file, quiet = TRUE)

Arguments

file

Character string with path to the YAML or JSON file containing all of the control information. This could instead be a zip file containing all of the data files, in which case the contents are unzipped to a temporary directory and then read.

quiet

If FALSE, print progress messages.

Details

A control file in YAML or JSON format contains information about basic parameters as well as the names of the series of data files to be read. See the sample data files and the vignette describing the input file format.

Value

Object of class "cross2". For details, see the R/qtl2 developer guide.

See Also

read_pheno(), write_control_file(), sample data files at https://kbroman.org/qtl2/pages/sampledata.html and https://github.com/rqtl/qtl2data

Examples

1
2
3
4
5
6
7
## Not run: 
yaml_file <- "https://kbroman.org/qtl2/assets/sampledata/grav2/grav2.yaml"
grav2 <- read_cross2(yaml_file)

## End(Not run)
zip_file <- system.file("extdata", "grav2.zip", package="qtl2")
grav2 <- read_cross2(zip_file)

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