Skip to contents

Return the list of creation options of a GDAL driver

Source: R/gdal_helpers.R
getCreationOptions.Rd

getCreationOptions() returns the list of creation options supported by a GDAL format driver as an XML string (invisibly). Wrapper for GDALGetDriverCreationOptionList() in the GDAL API. Information about the available creation options is also printed to the console by default.

Usage

getCreationOptions(format, filter = NULL)

Arguments

format

Raster format short name (e.g., "GTiff").

filter

Optional character vector of creation option names. Controls only the amount of information printed to the console. By default, information for all creation options is printed. Can be set to empty string "" to disable printing information to the console.

Value

Invisibly, an XML string that describes the full list of creation options or empty string "" (full output of GDALGetDriverCreationOptionList() in the GDAL API).

See also

GDALRaster-class, create(), createCopy()

Examples

getCreationOptions("GTiff", filter="COMPRESS")
#> {xml_node}
#> <Option name="COMPRESS" type="string-select">
#>  [1] <Value>NONE</Value>
#>  [2] <Value>LZW</Value>
#>  [3] <Value>PACKBITS</Value>
#>  [4] <Value>JPEG</Value>
#>  [5] <Value>CCITTRLE</Value>
#>  [6] <Value>CCITTFAX3</Value>
#>  [7] <Value>CCITTFAX4</Value>
#>  [8] <Value>DEFLATE</Value>
#>  [9] <Value>LZMA</Value>
#> [10] <Value>ZSTD</Value>
#> [11] <Value>WEBP</Value>