XIFtoTIFF {IFC} | R Documentation |
RIF/CIF File Conversion to TIFF
Description
Converts and subsets RIF or CIF files to TIFF. This function is experimental.
Usage
XIFtoTIFF(
fileName,
write_to,
objects,
offsets,
fast = TRUE,
endianness = .Platform$endian,
verbose = FALSE,
verbosity = 1,
overwrite = FALSE,
display_progress = TRUE,
add_tracking = TRUE,
...
)
Arguments
fileName |
path of file to subset. It has to be a '.rif' or '.cif' file. |
write_to |
pattern used to export file.
Placeholders, like "%d/%s_fromR.%e", will be substituted: |
objects |
integer vector, IDEAS objects ids numbers to use. If missing, the default, all objects will be used. |
offsets |
object of class ‘IFC_offset'. If missing, the default, offsets will be extracted from ’fileName'. |
fast |
whether to fast extract 'objects' or not. Default is TRUE.
Meaning that 'objects' will be extracted expecting that 'objects' are stored in ascending order. |
endianness |
The endian-ness ("big" or "little") of the target system for the file. Default is .Platform$endian. |
verbose |
whether to display information (use for debugging purpose). Default is FALSE. |
verbosity |
quantity of information displayed when verbose is TRUE; 1: normal, 2: rich. Default is 1. |
overwrite |
whether to overwrite file or not. Default is FALSE. |
display_progress |
whether to display a progress bar. Default is TRUE. |
add_tracking |
whether to register files' paths and objects' ids in the exported file. Default is TRUE. |
... |
other arguments to be passed. |
Details
This function is experiment and under development inputs and outputs may change in the future
Value
It invisibly returns full path of exported file.