zip_datafiles: Zip a set of data files

Description Usage Arguments Details Value See Also Examples

View source: R/zip_datafiles.R

Description

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

Usage

1
zip_datafiles(control_file, zip_file = NULL, overwrite = FALSE, 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.

overwrite

If TRUE, overwrite file if it exists. If FALSE (the default) and the file exists, stop with an error.

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 https://kbroman.org/qtl2/pages/sampledata.html

Examples

1
2
3
4
5
## Not run: 
zipfile <- file.path(tempdir(), "grav2.zip")
zip_datafiles("grav2.yaml", zipfile)

## End(Not run)

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