GDAL Options

GDAL options control how the GDAL/OGR library reads, writes, and otherwise processes geospatial data. This package models the distinct GDAL option channels as a small family of S3 classes, each backed by a named list of NAME = "VALUE" pairs (values stored as their coerced GDAL strings) plus a driver attribute, so a set of options is an inert, composable value that can be rendered on demand to whichever form a given consumer needs.

In the GDAL CLI, an option is supplied via one of these argument flags:

Classes

All four classes share the gdal_opts base (a named list) and differ only by channel:

• gdal_config_opts(): global, stateful configuration options. Applied to the process/session (via gdalraster::set_config_option()), not as an algorithm argument.

• gdal_open_opts(): driver open options.

• gdal_creation_opts(): driver dataset- or layer-creation options, selected by level.

• gdal_vsi_opts(): virtual file system (VSI) path-scoped options (config-like).

Rendering

A gdal_opts value is rendered with as_gdal_args() (CLI token vector for gdalraster::gdal_alg() / gdalraster::gdal_run()), as_config_option() (a NAME = VALUE character vector for gdalraster::set_config_option(), config/VSI only), or gdal_render() (a copy-pasteable shell snippet).

See also

as_gdal_args(), as_config_option(), gdal_render(); and the typed per-driver builders gpkg_open_opts(), gpq_creation_opts(), shp_open_opts(), fgb_creation_opts(), gdb_open_opts().