R.utils (version 1.6.2)

bunzip2: Bunzip a file

Description

Bunzip a file.

Usage

## S3 method for class 'default':
bunzip2(filename, destname=gsub("[.]bz2$", "", filename), overwrite=FALSE, remove=TRUE, BFR.SIZE=1e+07, ...)

Arguments

filename

Pathname of (bzip2'ed) input file to be bunzip2'ed.

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/compressed) bytes read.

Details

Internally bzfile() (see connections) is used to read chunks of the bzip2'ed file, which are then written to the output file.