zid {zooimage}

Manage .zid files (ZooImage Data)

Description

Compress, uncompress and verify ZooImage Data files.

Usage

zidCompress(zidir, type = c("ZI1", "ZI2", "ZI3", "ZI4", "ZI5"), check = TRUE,
    check.vignettes = TRUE, replace = FALSE, delete.source = replace)
zidCompressAll(path = ".", samples = NULL, type = c("ZI1", "ZI2", "ZI3", "ZI4", "ZI5"),
    check = TRUE, check.vignettes = TRUE, replace = FALSE,
    delete.source = replace)

zidClean(path = ".", samples = NULL)
zidDatMake(zidir, type = "ZI5", replace = FALSE)
zidDatRead(zidfile)

zidUncompress(zidfile, path = dirname(zidfile), delete.source = FALSE)
zidUncompressAll(path = ".", zidfiles = zidList(path, full.names = TRUE),
    path.extract = path, skip.existing.dirs = TRUE, delete.source = FALSE)

zidVerify(zidir, type = c("ZI1", "ZI2", "ZI3", "ZI4", "ZI5"), check.vignettes = TRUE)
zidVerifyAll(path = ".", samples = NULL, type = c("ZI1", "ZI2", "ZI3", "ZI4", "ZI5"),
    check.vignettes = TRUE)

Arguments

zidir

a directory containing data to put in a .zid files.

type

the ZI file format, currently 'ZI1', 'ZI2', 'ZI3', 'ZI4', or 'ZI5' types are supported (ZooImage1-5).

check

do we check the files in this directory before/after compression?

check.vignettes

do we check if the future .zid file contains all vignettes?

replace

do we replace existing files?

delete.source

do we delete source files after compression?

path

(un)compress or verify all subdirectories (except those starting with '\_') in respective .zid files. Also, a place where to put uncompressed files (in the 'sample' subdirectory).

samples

a list of 'samples', i.e., subdirectories to process.

zidfile

a .zid file to uncompress or read from.

zidfiles

a series of .zid files to uncompress.

path.extract

a place where to extract data from .zid files.

skip.existing.dirs

do not unzip if the subdir already exists.

Author(s)

Philippe Grosjean <[e-mail]>

See Also

zimMake

Examples

##TODO...