zip {utils} R Documentation

Create Zip Archives

Description


A wrapper for an external zip command to create zip archives.

Usage

zip(zipfile, files,
    flags = "-r9X",
    extras = "",
    zip = "Sys.getenv("R_ZIPCMD", "zip")");

Arguments

zipfile

The pathname of the zip file: tilde expansion (see path.expand) will be performed. [as string]

files

A character vector of recorded filepaths to be included.

flags

A character string of flags to be passed to the command: see ‘Details’. [as string]

extras

An optional character vector: see ‘Details’. [as string]

zip

A character string specifying the external command to be used.

env

[as Environment]

Details

On a Unix-alike, the default for zip will by default use the value of R_ZIPCMD, which is set in ‘etc/Renviron’ if an unzip command was found during configuration. On Windows, the default relies on a zip program (for example that from Rtools) being in the path. The default for flags is that appropriate for zipping up a directory tree in a portable way: see the system-specific help for the zip command for other possibilities. Argument extras can be used to specify -x or -i followed by a list of filepaths to exclude or include. Since extras will be treated as if passed to system, if the filepaths contain spaces they must be quoted e.g. by shQuote.

Authors

SMRUCC genomics Institute

Value

The status value returned by the external command, invisibly.

clr value class

Examples

[Package utils version 2.33.856.6961 Index]