gzip.GenericDataFile: Compresses/uncompresses a file

gzip.GenericDataFileR Documentation

Compresses/uncompresses a file

Description

Compresses/uncompresses a file using gzip compression. When compressing (uncompressing), the new filename has suffix .gz appended (removed), which is also used to test if a file is gzip'ed or not.

Usage

 ## S3 method for class 'GenericDataFile'
gzip(this, ...)
 ## S3 method for class 'GenericDataFile'
gunzip(this, ...)
 ## S3 method for class 'GenericDataFile'
isGzipped(this, ...)

Arguments

...

Arguments passed to "R.utils::gzip" and "R.utils::gunzip", respectively.

Value

Returns (invisibly) the updated pathname. When compressing (uncompressing), an exception is thrown if the file is already compressed (not compressed). An exception is thrown if the file does not exist.

Author(s)

Henrik Bengtsson

See Also

Internally gzip is used. For more information see GenericDataFile.


R.filesets documentation built on May 29, 2024, 9:10 a.m.