Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.
brainprep.interfaces.ungzfile¶
- brainprep.interfaces.ungzfile(input_file, output_file, output_dir, dryrun=False)[source]¶
Ungzip input file.
- Parameters:
- input_fileFile
Path to the file to ungzip.
- output_fileFile
Path to the ungzip file.
- output_dirDirectory
Directory where the unzip file is created.
- dryrunbool
If True, skip actual computation and file writing. Default False.
- Returns:
- output_fileFile
Path to the ungzip file.
- Raises:
- ValueError
If the input file is not compressed.