R.utils (version 1.5.8)

gzip: Gzip/Gunzip a file

Description

Gzip/Gunzip a file.

Usage

## S3 method for class 'default':
gzip(filename, destname=sprintf("\%s.gz", filename), overwrite=FALSE, remove=TRUE, BFR.SIZE=1e+07, ...)

Arguments

filename

Pathname of input file.

destname

Pathname of output file.

overwrite

If the output file already exists, then if overwrite is TRUE the file is silently overwritting, otherwise an exception is thrown.

remove

If TRUE, the input file is removed afterward, otherwise not.

BFR.SIZE

The number of bytes read in each chunk.

...

Not used.

Value

• Returns the number of (input) bytes read.

Details

Internally gzfile() (see connections) is used to read (write) chunks to (from) the gzip file. If the process is interrupted before completed, the partially written output file is automatically removed.

Examples

cat(file="foo.txt", "Hello world!")
  gzip("foo.txt")
  print(file.info("foo.txt.gz"))
  gunzip("foo.txt.gz")
  print(file.info("foo.txt"))
  file.remove("foo.txt")