ifcb_zip_pngs: Zip PNG Folders
In iRfcb: Tools for Managing Imaging FlowCytobot (IFCB) Data

ifcb_zip_pngs

R Documentation

Zip PNG Folders

Description

This function zips directories containing .png files and optionally includes README and MANIFEST files. It can also split the resulting zip file into smaller parts if it exceeds a specified size. The zip archive can be used to submit IFCB data to repositories like in the SMHI IFCB Plankton Image Reference Library (Torstensson et al., 2024).

Usage

ifcb_zip_pngs(
  png_folder,
  zip_filename,
  readme_file = NULL,
  email_address = "",
  version = "",
  print_progress = TRUE,
  include_txt = FALSE,
  split_zip = FALSE,
  max_size = 500,
  quiet = FALSE
)

Arguments

`png_folder`	The directory containing subdirectories with `.png` files.
`zip_filename`	The name of the zip file to create.
`readme_file`	Optional path to a README file for inclusion in the zip package.
`email_address`	Optional email address to include in the README file.
`version`	Optional version information to include in the README file.
`print_progress`	A logical value indicating whether to print progress bar. Default is TRUE.
`include_txt`	A logical value indicating whether to include text (`.txt`, `.tsv` and `.csv`) files located in the subdirectories. Default is FALSE.
`split_zip`	A logical value indicating whether to split the zip file into smaller parts if its size exceeds `max_size`. Default is FALSE.
`max_size`	The maximum size (in MB) for the zip file before it gets split. Only used if `split_zip` is TRUE. Default is 500 MB.
`quiet`	Logical. If TRUE, suppresses messages about the progress and completion of the zip process. Default is FALSE.

Value

This function does not return any value; it creates a zip archive and optionally splits it into smaller files if specified.

References

Torstensson, Anders; Skjevik, Ann-Turi; Mohlin, Malin; Karlberg, Maria; Karlson, Bengt (2024). SMHI IFCB Plankton Image Reference Library. SciLifeLab. Dataset. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.17044/scilifelab.25883455")}

Examples

## Not run: 
# Zip all subdirectories in the 'images' folder with a README file
ifcb_zip_pngs("path/to/images",
              "images.zip",
              readme_file = system.file("exdata/README-template.md", package = "iRfcb"),
              email_address = "example@example.com",
              version = "1.0")

# Zip all subdirectories in the 'images' folder without a README file
ifcb_zip_pngs("path/to/images", "images.zip")

## End(Not run)

iRfcb documentation built on April 16, 2025, 1:09 a.m.