zip_datafiles: Zip a set of data files

In rqtl/qtl2geno: Treatment of Marker Genotypes for QTL Experiments

Description

Zip a set of data files (in format read by read_cross2()).

Usage

zip_datafiles(control_file, zip_file = NULL, quiet = TRUE)

Arguments

control_file	Character string with path to the control file (YAML or JSON) containing all of the control information.
zip_file	Name of zip file to use. If NULL, we use the stem of control_file but with a .zip extension.
quiet	If FALSE, print progress messages.

Details

The input control_file is the control file (in YAML or JSON format) to be read by read_cross2(). (See the sample data files and the vignette describing the input file format.)

The utils::zip() function is used to do the zipping.

The files should all be contained within the directory where the control_file sits, or in a subdirectory of that directory. If file paths use .., these get stripped by zip, and so the resulting zip file may not work with read_cross2().

Value

Character string with the file name of the zip file that was created.

See Also

read_cross2(), sample data files at http://kbroman.org/qtl2/pages/sampledata.html

Examples

## Not run: 
control_file <- "~/grav2_data/grav2.yaml"
zip_datafiles(control_file, "grav2.zip")

## End(Not run)

rqtl/qtl2geno documentation built on May 28, 2019, 2:36 a.m.