Last data update: 2014.03.03

R: Manage .zidb files (ZooImage Databases)
zidbR Documentation

Manage .zidb files (ZooImage Databases)

Description

Compress, uncompress .zidb files that contain data for a sample. Starting from ZooImage 3, the new format uses filehash tables for better performances. Conversion from and to the old .zid format (a zip archive indeed) is supported for compatibility with old datasets.

Usage

zidbMake(zidir, zidbfile = paste0(zidir, ".zidb"), zisfile =
    file.path(dirname(zidir), "Description.zis"), type = "ZI3", check = TRUE,
    check.vignettes = TRUE, replace = FALSE, delete.source = replace)
zidbMakeAll(path = ".", samples, zisfiles = file.path(dirname(samples),
    "Description.zis"), type = "ZI3", check = TRUE,
    check.vignettes = TRUE, replace = FALSE, delete.source = replace)
    
zidToZidb(zidfile, zisfile = file.path(dirname(zidfile),
    "Description.zis"), replace = FALSE, delete.source = replace)
zidToZidbAll(path = ".", zidfiles, zisfiles = file.path(dirname(zidfiles),
    "Description.zis"), replace = FALSE, delete.source = replace)
zidbToZid(zidbfile, zisfile = file.path(dirname(zidbfile),
    "Description.zis"), replace = FALSE, delete.source = replace)
zidbToZidAll(path = ".", zidbfiles, zisfiles = file.path(dirname(zidbfiles),
    "Description.zis"), replace = FALSE, delete.source = replace)
    
zidbLink(zidbfile)
zidbDatRead(zidbfile)
zidbSampleRead(zidbfile)

zidbPlotNew(main = "ZooImage collage", ...)
zidbDrawVignette(rawimg, type = "jpg", item, nx = 5, ny = 5, vmar = 0.01)

Arguments

zidir

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

zidbfile

the path of the .zidb file.

zidbfiles

the path of a series of .zidb files.

zidfile

the path of a .zid file.

zidfiles

the path of a series of .zid files.

zisfile

the path of the .zis file that contains description of this sample.

zisfiles

the path of a series of .zis files that contain description of the processed samples.

type

the ZI file format, currently only 'ZI3' type is supported. For zidbDrawVignette(), it is the type of vignette image. Currently, it can be either "jpg", or "png".

check

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

check.vignettes

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

replace

do we replace existing files?

delete.source

do we delete source files after compression?

path

look for files in this path.

samples

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

main

the title of the new plot.

...

further arguments passed to the plot() function.

rawimg

the raw content of a vignette, as stored in a .zidb file.

item

the item number to draw (enumeration from left to right and from top to bottom).

nx

the number of vignettes in a column.

ny

the number of vignettes in a row.

vmar

the relative size of vignette margins.

Author(s)

Philippe Grosjean <Philippe.Grosjean@umons.ac.be>

See Also

zidCompress

Examples

##TODO...

Results