diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 873842a9..385f9590 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -242,31 +242,74 @@ auth <- gdal_auth_gcs() # GOOGLE_APPLICATION_CREDENTIALS job |> gdal_with_env(auth) |> gdal_run() ## GDAL Version Compatibility -GDAL 3.13.0+ introduced parameter naming standardization. Known changes include: -- `dst_crs` → `output_crs` (reproject and related CRS output functions) -- `dataset` → `input` (functions that previously used `dataset` parameter) -GDAL's API continues to evolve; consult GDAL release notes for version-specific parameter changes. +### Cross-Version Support +gdalcli 0.7.1+ provides **automatic, transparent compatibility** across GDAL versions 3.11.4 through 3.13+. -Use `gdal_check_version()` for version-aware code: +**RFC 104 Parameter Standardization** introduced parameter naming changes starting in GDAL 3.12.0: +- CRS parameters: `dst_crs` → `output_crs`, `src_crs` → `input_crs` +- Dataset parameters: `dataset` → `input` +- Override parameters: `a_srs` → `override_crs` (for CRS override without reprojection) +- Legacy aliases: `s_srs` (old gdal_translate), `t_srs` (old gdalwarp) automatically converted +- Backward compatibility: Old names accepted throughout the CLI + +### How It Works +All 83 auto-generated functions use **version-aware parameter alias routing** internally: +- Code detects the installed GDAL version at runtime +- Parameters are automatically mapped to the correct names for that version (GDAL 3.12+: use new names; older: use old names) +- Users can pass either old (`dst_crs`) or new (`output_crs`) parameter names +- System automatically selects correct name for installed GDAL version + +**Complete parameter alias support** (RFC 104): +- `dst_crs`, `t_srs` → `output_crs` (standardized in GDAL 3.12.0+) +- `src_crs`, `s_srs` → `input_crs` (standardized in GDAL 3.12.0+) +- `a_srs` → `override_crs` (standardized in GDAL 3.12.0+) +- `dataset` → `input` (standardized in GDAL 3.12.0+) + +### Using Version-Specific Parameters +For code that needs to explicitly handle GDAL version differences, use `gdal_check_version()`: ```r -# Example: Reproject function (dst_crs → output_crs) -if (gdal_check_version("3.13", op = ">=")) { +# Example: Using either old or new parameter names (both work) +# On GDAL 3.12+: uses output_crs, on older: uses dst_crs +job <- gdal_raster_reproject(input = "in.tif", output_crs = "EPSG:4326") +job <- gdal_raster_reproject(input = "in.tif", dst_crs = "EPSG:4326") # Also works! + +# Example: Legacy parameter names (e.g., from old gdal_translate/gdalwarp scripts) +job <- gdal_raster_reproject(input = "in.tif", t_srs = "EPSG:4326") # Old gdalwarp name +job <- gdal_vector_reproject(input = "in.gpkg", s_srs = "EPSG:4326") # Old source CRS name + +# Example: Explicit version checks for complex logic +if (gdal_check_version("3.12", op = ">=")) { job <- gdal_raster_reproject(input = "in.tif", output_crs = "EPSG:4326") } else { job <- gdal_raster_reproject(input = "in.tif", dst_crs = "EPSG:4326") } - -# Example: Overview function (dataset → input) -if (gdal_check_version("3.13", op = ">=")) { - job <- gdal_raster_overview_add(input = "in.tif", levels = c(2, 4, 8)) -} else { - job <- gdal_raster_overview_add(dataset = "in.tif", levels = c(2, 4, 8)) -} ``` + +### Parameter Synonyms + +Beyond version-aware aliases, gdalcli supports **parameter synonyms** — alternative names for the same parameter that are always valid. This provides flexibility when migrating code or using familiar parameter names: + +```r +# Example: output_format synonyms (all equivalent) +job <- gdal_raster_convert(input = "in.tif", output = "out.tif", output_format = "COG") +job <- gdal_raster_convert(input = "in.tif", output = "out.tif", format = "COG") # Shorter alias +job <- gdal_raster_convert(input = "in.tif", output = "out.tif", of = "COG") # Common abbreviation + +# Example: input_layer synonyms (all equivalent) +job <- gdal_vector_convert(input = "in.gpkg", output = "out.gpkg", input_layer = "my_layer") +job <- gdal_vector_convert(input = "in.gpkg", output = "out.gpkg", layer = "my_layer") # Shorter +job <- gdal_vector_convert(input = "in.gpkg", output = "out.gpkg", input-layer = "my_layer") # Dash variant ``` +All synonyms are automatically normalized to their canonical parameter names, ensuring compatibility across different coding styles and legacy scripts. + +### Recommended Approach +**In most cases, just use the modern parameter names** (`output_crs`, `input_crs`, `input`, `override_crs`) — gdalcli's version routing handles the rest automatically regardless of installed GDAL version. The system works seamlessly whether users are on GDAL 3.11.4, 3.12.0, 3.13.0, or newer. + +For parameter synonyms, use whichever name you find most readable or natural — all alternatives work identically. The system normalizes them behind the scenes. + ### Programmatic Command Invocation `gdal_call()` enables dynamic command invocation by name or function reference, supporting metaprogramming and serialization patterns: diff --git a/DESCRIPTION b/DESCRIPTION index cad5a078..fc0a8c35 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: gdalcli Title: Frontend for the GDAL (>= 3.11) CLI -Version: 0.7.0 +Version: 0.7.1 Authors@R: person("Andrew", "Brown", role = c("aut", "cre"), email = "brown.andrewg@gmail.com", diff --git a/NEWS.md b/NEWS.md index 5283c0ea..c40ec4ce 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# gdalcli 0.7.1 (2026-05-10) + +- All generated functions gain an ellipsis and support parameter synonyms (e.g., `format`/`of` for `output_format`) + # gdalcli 0.7.0 (2026-05-09) - Added update intent feature for pipeline classification. Now code generation auto-detects commands that open files for update (e.g., `gdal_raster_edit`, `gdal_vector_edit`) via `GDAL_INTENT_MAPPINGS.json` with customizable overrides diff --git a/R/core-gdal_parameter_aliases.R b/R/core-gdal_parameter_aliases.R new file mode 100644 index 00000000..6f153540 --- /dev/null +++ b/R/core-gdal_parameter_aliases.R @@ -0,0 +1,44 @@ +#' GDAL Parameter Aliases and Synonyms +#' +#' Documentation of parameter aliases and synonyms supported by gdalcli functions +#' for backward compatibility across GDAL versions. +#' +#' @details +#' All gdalcli wrapper functions support flexible parameter naming through two mechanisms: +#' +#' **Version-aware aliases**: Old GDAL parameter names (introduced before RFC 104) +#' automatically route to modern names on GDAL 3.12+, where parameter standardization +#' (RFC 104) introduced the new naming scheme. Backward compatibility is maintained +#' throughout: pass either old or new names; routing is automatic. +#' +#' Common aliases (RFC 104 - GDAL 3.12+): +#' - `dst_crs` or `t_srs` -> `output_crs` (standardized CRS destination parameter) +#' - `src_crs` or `s_srs` -> `input_crs` (standardized CRS source parameter) +#' - `dataset` -> `input` (unified input parameter naming) +#' - `a_srs` -> `override_crs` (CRS override without reprojection) +#' +#' **Parameter synonyms**: Alternative names for the same parameter that are always +#' valid, regardless of GDAL version. Useful for shorter or more familiar parameter names. +#' +#' Common synonyms: +#' - `output_format`: also accepts `format`, `of`, `output-format` +#' - `input_layer`: also accepts `layer`, `input-layer` +#' +#' Users can pass parameters using either old or new names; the system automatically +#' handles routing to the correct names for the installed GDAL version. +#' +#' @examples +#' \dontrun{ +#' # All of these are equivalent across GDAL versions +#' job1 <- gdal_raster_reproject(input = "in.tif", output_crs = "EPSG:4326") +#' job2 <- gdal_raster_reproject(input = "in.tif", dst_crs = "EPSG:4326") # Old name +#' job3 <- gdal_raster_reproject(input = "in.tif", t_srs = "EPSG:4326") # Legacy gdalwarp name +#' +#' # Parameter synonyms +#' conv1 <- gdal_raster_convert(input = "in.tif", output_format = "COG") +#' conv2 <- gdal_raster_convert(input = "in.tif", format = "COG") # Shorter +#' conv3 <- gdal_raster_convert(input = "in.tif", of = "COG") # Abbreviation +#' } +#' @seealso [gdal_call()] for dynamic command invocation, [gdal_check_version()] for version-specific logic +#' @name gdal_parameter_aliases +NULL diff --git a/R/core-optional-features.R b/R/core-optional-features.R index 18de7416..aec20ad5 100644 --- a/R/core-optional-features.R +++ b/R/core-optional-features.R @@ -267,7 +267,7 @@ gdal_capabilities <- function() { current = version, is_3_11 = gdal_check_version("3.11", op = ">="), is_3_12 = gdal_check_version("3.12", op = ">="), - is_3_13 = gdal_check_version("3.13", op = ">=") + is_3_13 = gdal_check_version("3.12.2", op = ">=") ), features = list( explicit_args = .gdal_has_feature("explicit_args"), diff --git a/R/core-parameter-aliases.R b/R/core-parameter-aliases.R new file mode 100644 index 00000000..d974d34e --- /dev/null +++ b/R/core-parameter-aliases.R @@ -0,0 +1,136 @@ +# Parameter alias and synonym handling +# Supports: (1) version-aware renames (RFC 104), (2) parameter synonyms +# Routes old parameter names (dst_crs > output_crs, dataset > input, etc.) based on GDAL version +# Normalizes synonyms (format/of > output_format, layer/input-layer > input_layer) always + +#' Merge Parameter Aliases and Synonyms +#' +#' Handle parameter aliases (version-aware) and synonyms (always valid). +#' Routes old parameter names based on GDAL version; normalizes synonyms to canonical names. +#' +#' @param dots List from `...` containing potential aliases/synonyms +#' @param named_args Named parameters from function signature +#' @param gdal_version GDAL version string (optional, auto-detected if NULL) +#' +#' @return List of merged parameters with aliases and synonyms resolved +#' @keywords internal +.merge_alias_parameters <- function(dots, named_args, gdal_version = NULL) { + # Canonical parameter names with version-aware aliases and synonyms + canonical_params <- list( + # CRS parameters (old names: dst_crs, t_srs, src_crs, s_srs, a_srs) + output_crs = list( + aliases = c("dst_crs", "t_srs"), + old_name = "dst_crs", + synonyms = c() + ), + input_crs = list( + aliases = c("src_crs", "s_srs"), + old_name = "src_crs", + synonyms = c() + ), + override_crs = list( + aliases = c("a_srs"), + old_name = "a_srs", + synonyms = c() + ), + # Dataset/input parameters (old name: dataset) + input = list( + aliases = c("dataset"), + old_name = "dataset", + synonyms = c() + ), + # Output format (synonyms only) + output_format = list( + aliases = c(), + old_name = NULL, + synonyms = c("format", "of", "output-format") + ), + # Layer parameters (synonyms only) + input_layer = list( + aliases = c(), + old_name = NULL, + synonyms = c("layer", "input-layer") + ), + output_layer = list( + aliases = c(), + old_name = NULL, + synonyms = c() + ) + ) + + # Check if we're on GDAL 3.12+ + # Parameter renames (RFC 104) introduced in GDAL 3.12.0, standardized in 3.13.0 + # Backward compatibility: old names accepted in CLI, routed to new names + is_new_version <- gdal_check_version("3.12", op = ">=") + + # Start with existing named arguments + result <- named_args + + if (length(dots) > 0) { + for (arg_name in names(dots)) { + canonical_name <- arg_name + found_mapping <- FALSE + mapping_type <- NULL + + # Check if already canonical + if (arg_name %in% names(canonical_params)) { + canonical_name <- arg_name + found_mapping <- TRUE + mapping_type <- "canonical" + } else { + # Look for version-aware aliases or synonyms + for (can_name in names(canonical_params)) { + param_config <- canonical_params[[can_name]] + + if (arg_name %in% param_config$aliases) { + canonical_name <- can_name + found_mapping <- TRUE + mapping_type <- "version_alias" + break + } + + if (arg_name %in% param_config$synonyms) { + canonical_name <- can_name + found_mapping <- TRUE + mapping_type <- "synonym" + break + } + } + } + + if (found_mapping) { + if (mapping_type == "version_alias") { + # Route based on GDAL version + if (is_new_version) { + if (is.null(result[[canonical_name]])) { + result[[canonical_name]] <- dots[[arg_name]] + } + } else { + old_name <- canonical_params[[canonical_name]]$old_name + if (!is.null(old_name) && is.null(result[[old_name]])) { + result[[old_name]] <- dots[[arg_name]] + } + } + } else if (mapping_type == "synonym") { + # Normalize to canonical name + if (is.null(result[[canonical_name]])) { + result[[canonical_name]] <- dots[[arg_name]] + } + } else if (mapping_type == "canonical") { + # Already canonical + if (is.null(result[[arg_name]])) { + result[[arg_name]] <- dots[[arg_name]] + } + } + } else { + # No mapping found + if (is.null(result[[arg_name]])) { + result[[arg_name]] <- dots[[arg_name]] + } + } + } + } + + result +} + diff --git a/R/gdal.R b/R/gdal.R index 58b85072..b93fe9b8 100644 --- a/R/gdal.R +++ b/R/gdal.R @@ -11,6 +11,7 @@ #' See \url{https://gdal.org/en/release-3.11/programs/gdal.html} for detailed GDAL documentation. #' @param x A filename (for 'gdal info'), a pipeline string (for 'gdal pipeline'), a command vector, or a gdal_job object from a piped operation #' @param drivers Display driver list as JSON document (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_utilities #' @examples @@ -23,7 +24,8 @@ #' } #' @export gdal <- function(x = NULL, - drivers = FALSE) { + drivers = FALSE, + ...) { if (!is.null(x)) { # Check if x is a piped gdal_job @@ -93,6 +95,7 @@ gdal <- function(x = NULL, merged_args <- list() if (!missing(drivers)) merged_args[["drivers"]] <- drivers + merged_args <- .merge_alias_parameters(list(...), merged_args) .update_intent <- "SAFE" .arg_mapping <- list( diff --git a/R/gdal_driver_gpkg_repack.R b/R/gdal_driver_gpkg_repack.R index d2bc8d84..3a7f21f2 100644 --- a/R/gdal_driver_gpkg_repack.R +++ b/R/gdal_driver_gpkg_repack.R @@ -10,6 +10,7 @@ #' #' See \url{https://gdal.org/en/release-3.11/programs/gdal_driver_gpkg_repack.html} for detailed GDAL documentation. #' @param dataset GeoPackage dataset (Dataset path) (required). Can also be a [gdal_job] object to extend a pipeline +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_driver_utilities #' @examples @@ -19,7 +20,8 @@ #' result <- gdal_job_run(job) #' } #' @export -gdal_driver_gpkg_repack <- function(dataset) { +gdal_driver_gpkg_repack <- function(dataset, + ...) { new_args <- list() if (!missing(dataset)) new_args[["dataset"]] <- dataset @@ -34,7 +36,7 @@ gdal_driver_gpkg_repack <- function(dataset) { } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_driver_gpkg_repack", merged_args, .update_intent_mapping) diff --git a/R/gdal_driver_gti_create.R b/R/gdal_driver_gti_create.R index 8e87a684..fd276dd9 100644 --- a/R/gdal_driver_gti_create.R +++ b/R/gdal_driver_gti_create.R @@ -36,6 +36,7 @@ #' @param color_interpretation Color interpretation(s) of the bands of the virtual mosaic (Character vector). Choices: "red", "green", "blue", "alpha", "gray", ... #' @param mask Defines that the virtual mosaic has a mask band (Logical) #' @param fetch_metadata Fetch a metadata item from source rasters and write it as a field in the index. (Character vector). Format: `,,` +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_driver_utilities #' @examples @@ -72,7 +73,8 @@ gdal_driver_gti_create <- function(input, nodata = NULL, color_interpretation = NULL, mask = FALSE, - fetch_metadata = NULL) { + fetch_metadata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output)) new_args[["output"]] <- output @@ -113,7 +115,7 @@ gdal_driver_gti_create <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_driver_gti_create", merged_args, .update_intent_mapping) diff --git a/R/gdal_driver_openfilegdb_repack.R b/R/gdal_driver_openfilegdb_repack.R index ab138bc5..4113edc7 100644 --- a/R/gdal_driver_openfilegdb_repack.R +++ b/R/gdal_driver_openfilegdb_repack.R @@ -11,6 +11,7 @@ #' #' See \url{https://gdal.org/en/release-3.11/programs/gdal_driver_openfilegdb_repack.html} for detailed GDAL documentation. #' @param dataset FileGeoDatabase dataset (Dataset path) (required). Can also be a [gdal_job] object to extend a pipeline +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_driver_utilities #' @examples @@ -20,7 +21,8 @@ #' result <- gdal_job_run(job) #' } #' @export -gdal_driver_openfilegdb_repack <- function(dataset) { +gdal_driver_openfilegdb_repack <- function(dataset, + ...) { new_args <- list() if (!missing(dataset)) new_args[["dataset"]] <- dataset @@ -35,7 +37,7 @@ gdal_driver_openfilegdb_repack <- function(dataset) { } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_driver_openfilegdb_repack", merged_args, .update_intent_mapping) diff --git a/R/gdal_driver_pdf_list_layers.R b/R/gdal_driver_pdf_list_layers.R index 7d888d64..11af02db 100644 --- a/R/gdal_driver_pdf_list_layers.R +++ b/R/gdal_driver_pdf_list_layers.R @@ -11,6 +11,7 @@ #' See \url{https://gdal.org/en/release-3.11/programs/gdal_driver_pdf_list-layers.html} for detailed GDAL documentation. #' @param input Input raster or vector dataset (Dataset path) (required). Can also be a [gdal_job] object to extend a pipeline #' @param output_format Output format. Choices: "json", "text" (Default: `json`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_driver_utilities #' @examples @@ -22,7 +23,8 @@ #' } #' @export gdal_driver_pdf_list_layers <- function(input, - output_format = NULL) { + output_format = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output_format)) new_args[["output_format"]] <- output_format @@ -38,7 +40,7 @@ gdal_driver_pdf_list_layers <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_driver_pdf_list_layers", merged_args, .update_intent_mapping) diff --git a/R/gdal_mdim.R b/R/gdal_mdim.R index 51f1ce47..a66cb6f1 100644 --- a/R/gdal_mdim.R +++ b/R/gdal_mdim.R @@ -10,6 +10,7 @@ #' #' See \url{https://gdal.org/en/release-3.11/programs/gdal_mdim.html} for detailed GDAL documentation. #' @param drivers Display multidimensional driver list as JSON document (Logical). Can also be a [gdal_job] object to extend a pipeline +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_mdim_utilities #' @examples @@ -21,7 +22,8 @@ #' # gdal_job_run(job) #' } #' @export -gdal_mdim <- function(drivers = FALSE) { +gdal_mdim <- function(drivers = FALSE, + ...) { new_args <- list() if (!missing(drivers)) new_args[["drivers"]] <- drivers @@ -36,7 +38,7 @@ gdal_mdim <- function(drivers = FALSE) { } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_mdim", merged_args, .update_intent_mapping) diff --git a/R/gdal_mdim_convert.R b/R/gdal_mdim_convert.R index fd5ccd41..dbefa7d5 100644 --- a/R/gdal_mdim_convert.R +++ b/R/gdal_mdim_convert.R @@ -22,6 +22,7 @@ #' @param subset Select a subset of the data. (Character vector). Format: `SUBSET-SPEC` #' @param scale_axes Applies a integral scale factor to one or several dimensions (Character vector). Format: `SCALEAXES-SPEC` #' @param strict Turn warnings into failures. (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_mdim_utilities #' @examples @@ -43,7 +44,8 @@ gdal_mdim_convert <- function(input, group = NULL, subset = NULL, scale_axes = NULL, - strict = FALSE) { + strict = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -70,7 +72,7 @@ gdal_mdim_convert <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_mdim_convert", merged_args, .update_intent_mapping) diff --git a/R/gdal_mdim_info.R b/R/gdal_mdim_info.R index 7cf46211..30c7a06c 100644 --- a/R/gdal_mdim_info.R +++ b/R/gdal_mdim_info.R @@ -18,6 +18,7 @@ #' @param array_option Option passed to GDALGroup::GetMDArrayNames() to filter reported arrays. (Character vector). Format: `=` #' @param stats Read and display image statistics. (Logical) #' @param stdout Directly output on stdout. If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_mdim_utilities #' @examples @@ -35,7 +36,8 @@ gdal_mdim_info <- function(input, limit = NULL, array_option = NULL, stats = FALSE, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(open_option)) new_args[["open_option"]] <- open_option @@ -58,7 +60,7 @@ gdal_mdim_info <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_mdim_info", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster.R b/R/gdal_raster.R index fe5d77b6..bbd92bfd 100644 --- a/R/gdal_raster.R +++ b/R/gdal_raster.R @@ -10,6 +10,7 @@ #' #' See \url{https://gdal.org/en/release-3.11/programs/gdal_raster.html} for detailed GDAL documentation. #' @param drivers Display raster driver list as JSON document (Logical). Can also be a [gdal_job] object to extend a pipeline +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -21,7 +22,8 @@ #' # gdal_job_run(job) #' } #' @export -gdal_raster <- function(drivers = FALSE) { +gdal_raster <- function(drivers = FALSE, + ...) { new_args <- list() if (!missing(drivers)) new_args[["drivers"]] <- drivers @@ -36,7 +38,7 @@ gdal_raster <- function(drivers = FALSE) { } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_aspect.R b/R/gdal_raster_aspect.R index 523bc8e1..de2fcdd0 100644 --- a/R/gdal_raster_aspect.R +++ b/R/gdal_raster_aspect.R @@ -21,6 +21,7 @@ #' @param gradient_alg Algorithm used to compute terrain gradient. Choices: "Horn", "ZevenbergenThorne" (Default: `Horn`) #' @param zero_for_flat Whether to output zero for flat areas (Logical) #' @param no_edges Do not try to interpolate values at dataset edges or close to nodata values (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -41,7 +42,8 @@ gdal_raster_aspect <- function(input, convention = NULL, gradient_alg = NULL, zero_for_flat = FALSE, - no_edges = FALSE) { + no_edges = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -67,7 +69,7 @@ gdal_raster_aspect <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_aspect", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_calc.R b/R/gdal_raster_calc.R index 2a32324a..2ad0ddc4 100644 --- a/R/gdal_raster_calc.R +++ b/R/gdal_raster_calc.R @@ -18,6 +18,7 @@ #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) #' @param no_check_srs Do not check consistency of input spatial reference systems (Logical) #' @param no_check_extent Do not check consistency of input extents (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -35,7 +36,8 @@ gdal_raster_calc <- function(input, creation_option = NULL, overwrite = FALSE, no_check_srs = FALSE, - no_check_extent = FALSE) { + no_check_extent = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output)) new_args[["output"]] <- output @@ -58,7 +60,7 @@ gdal_raster_calc <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_calc", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_clean_collar.R b/R/gdal_raster_clean_collar.R index 63d3de02..48432371 100644 --- a/R/gdal_raster_clean_collar.R +++ b/R/gdal_raster_clean_collar.R @@ -23,6 +23,7 @@ #' @param add_alpha Adds an alpha band to the output dataset. (Logical) #' @param add_mask Adds a mask band to the output dataset. (Logical) #' @param algorithm Algorithm to apply. Choices: "floodfill", "twopasses" (Default: `floodfill`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -45,7 +46,8 @@ gdal_raster_clean_collar <- function(input, pixel_distance = NULL, add_alpha = FALSE, add_mask = FALSE, - algorithm = NULL) { + algorithm = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -73,7 +75,7 @@ gdal_raster_clean_collar <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- list(dataset = list(by_default = FALSE, if_any_of = "update")) .update_intent <- infer_update_intent("gdal_raster_clean_collar", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_clip.R b/R/gdal_raster_clip.R index df9b9bf6..70bd735c 100644 --- a/R/gdal_raster_clip.R +++ b/R/gdal_raster_clip.R @@ -27,6 +27,7 @@ #' @param only_bbox For 'geometry' and 'like', only consider their bounding box (Logical) #' @param allow_bbox_outside_source Allow clipping box to include pixels outside input dataset (Logical) #' @param add_alpha Adds an alpha mask band to the destination when the source raster have none. (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -54,7 +55,8 @@ gdal_raster_clip <- function(input, like_where = NULL, only_bbox = FALSE, allow_bbox_outside_source = FALSE, - add_alpha = FALSE) { + add_alpha = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -86,7 +88,7 @@ gdal_raster_clip <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_clip", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_color_map.R b/R/gdal_raster_color_map.R index a6d1ec6a..ed92a85e 100644 --- a/R/gdal_raster_color_map.R +++ b/R/gdal_raster_color_map.R @@ -20,6 +20,7 @@ #' @param color_map Color map filename #' @param add_alpha Adds an alpha mask band to the destination. (Logical) #' @param color_selection How to compute output colors from input values. Choices: "interpolate", "exact", "nearest" (Default: `interpolate`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -40,7 +41,8 @@ gdal_raster_color_map <- function(input, band = NULL, color_map = NULL, add_alpha = FALSE, - color_selection = NULL) { + color_selection = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -65,7 +67,7 @@ gdal_raster_color_map <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_color_map", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_contour.R b/R/gdal_raster_contour.R index 44447690..0e5b4f56 100644 --- a/R/gdal_raster_contour.R +++ b/R/gdal_raster_contour.R @@ -30,6 +30,7 @@ #' @param polygonize Create polygons instead of lines (Logical) #' @param group_transactions Group n features per transaction (default 100 000) (Integer). Minimum: `0` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -59,7 +60,8 @@ gdal_raster_contour <- function(input, offset = NULL, polygonize = FALSE, group_transactions = NULL, - overwrite = FALSE) { + overwrite = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -94,7 +96,7 @@ gdal_raster_contour <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_contour", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_convert.R b/R/gdal_raster_convert.R index cf915b21..1249af4b 100644 --- a/R/gdal_raster_convert.R +++ b/R/gdal_raster_convert.R @@ -17,6 +17,7 @@ #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) #' @param append Append as a subdataset to existing output (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -35,7 +36,8 @@ gdal_raster_convert <- function(input, open_option = NULL, creation_option = NULL, overwrite = FALSE, - append = FALSE) { + append = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -57,7 +59,7 @@ gdal_raster_convert <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_convert", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_create.R b/R/gdal_raster_create.R index a8470308..d3f079a1 100644 --- a/R/gdal_raster_create.R +++ b/R/gdal_raster_create.R @@ -27,6 +27,7 @@ #' @param metadata Add metadata item (Character vector). Format: `=` #' @param copy_metadata Copy metadata from input dataset (Logical) #' @param copy_overviews Create same overview levels as input dataset (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -54,7 +55,8 @@ gdal_raster_create <- function(input = NULL, bbox = NULL, metadata = NULL, copy_metadata = FALSE, - copy_overviews = FALSE) { + copy_overviews = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -86,7 +88,7 @@ gdal_raster_create <- function(input = NULL, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_create", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_edit.R b/R/gdal_raster_edit.R index 40145a94..adde8d86 100644 --- a/R/gdal_raster_edit.R +++ b/R/gdal_raster_edit.R @@ -19,6 +19,7 @@ #' @param stats Compute statistics, using all pixels (Logical) #' @param approx_stats Compute statistics, using a subset of pixels (Logical) #' @param hist Compute histogram (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -37,7 +38,8 @@ gdal_raster_edit <- function(dataset, unset_metadata = NULL, stats = FALSE, approx_stats = FALSE, - hist = FALSE) { + hist = FALSE, + ...) { new_args <- list() if (!missing(dataset)) new_args[["dataset"]] <- dataset if (!missing(auxiliary)) new_args[["auxiliary"]] <- auxiliary @@ -61,7 +63,7 @@ gdal_raster_edit <- function(dataset, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- list(dataset = list(by_default = TRUE, unless_any_of = "auxiliary")) .update_intent <- infer_update_intent("gdal_raster_edit", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_fill_nodata.R b/R/gdal_raster_fill_nodata.R index 530c0d11..e5209637 100644 --- a/R/gdal_raster_fill_nodata.R +++ b/R/gdal_raster_fill_nodata.R @@ -20,6 +20,7 @@ #' @param smoothing_iterations The number of 3x3 average filter smoothing iterations to run after the interpolation to dampen artifacts. The default is zero smoothing iterations. (Integer). Format: `SMOOTHING_ITERATIONS` (Default: `0`) #' @param mask Use the first band of the specified file as a validity mask (zero is invalid, non-zero is valid). (Dataset path) #' @param strategy By default, pixels are interpolated using an inverse distance weighting (invdist). It is also possible to choose a nearest neighbour (nearest) strategy.. Choices: "invdist", "nearest" (Default: `invdist`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -40,7 +41,8 @@ gdal_raster_fill_nodata <- function(input, max_distance = NULL, smoothing_iterations = NULL, mask = NULL, - strategy = NULL) { + strategy = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -65,7 +67,7 @@ gdal_raster_fill_nodata <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_fill_nodata", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_footprint.R b/R/gdal_raster_footprint.R index c7bbff99..41ae6902 100644 --- a/R/gdal_raster_footprint.R +++ b/R/gdal_raster_footprint.R @@ -34,6 +34,7 @@ #' @param location_field Name of the field where the path of the input dataset will be stored. (Default: `location`) #' @param no_location_field Disable creating a field with the path of the input dataset (Logical) #' @param absolute_path Whether the path to the input dataset should be stored as an absolute path (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -67,7 +68,8 @@ gdal_raster_footprint <- function(input, max_points = NULL, location_field = NULL, no_location_field = FALSE, - absolute_path = FALSE) { + absolute_path = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -106,7 +108,7 @@ gdal_raster_footprint <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_footprint", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_hillshade.R b/R/gdal_raster_hillshade.R index dcc983d2..c0dfe512 100644 --- a/R/gdal_raster_hillshade.R +++ b/R/gdal_raster_hillshade.R @@ -25,6 +25,7 @@ #' @param gradient_alg Algorithm used to compute terrain gradient. Choices: "Horn", "ZevenbergenThorne" (Default: `Horn`) #' @param variant Variant of the hillshading algorithm. Choices: "regular", "combined", "multidirectional", "Igor" (Default: `regular`) #' @param no_edges Do not try to interpolate values at dataset edges or close to nodata values (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -50,7 +51,8 @@ gdal_raster_hillshade <- function(input, altitude = NULL, gradient_alg = NULL, variant = NULL, - no_edges = FALSE) { + no_edges = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -80,7 +82,7 @@ gdal_raster_hillshade <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_hillshade", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_index.R b/R/gdal_raster_index.R index c20366e5..329624a3 100644 --- a/R/gdal_raster_index.R +++ b/R/gdal_raster_index.R @@ -29,6 +29,7 @@ #' @param absolute_path Whether the path to the input datasets should be stored as an absolute path (Logical) #' @param dst_crs Destination CRS #' @param metadata Add dataset metadata item (Character vector). Format: `=` +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -57,7 +58,8 @@ gdal_raster_index <- function(input, location_name = NULL, absolute_path = FALSE, dst_crs = NULL, - metadata = NULL) { + metadata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(source_crs_field_name)) new_args[["source_crs_field_name"]] <- source_crs_field_name @@ -91,7 +93,7 @@ gdal_raster_index <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_index", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_info.R b/R/gdal_raster_info.R index 2ecec7f1..45cb2a7b 100644 --- a/R/gdal_raster_info.R +++ b/R/gdal_raster_info.R @@ -28,6 +28,7 @@ #' @param no_mask Suppress mask band information (Logical) (Esoteric) #' @param subdataset Use subdataset of specified index (starting at 1), instead of the source dataset itself (Integer). Minimum: `1` (Esoteric) #' @param stdout Directly output on stdout (format=text mode only). If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -55,7 +56,8 @@ gdal_raster_info <- function(input, no_nodata = FALSE, no_mask = FALSE, subdataset = NULL, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -88,7 +90,7 @@ gdal_raster_info <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_info", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_mosaic.R b/R/gdal_raster_mosaic.R index 8358aa13..49946148 100644 --- a/R/gdal_raster_mosaic.R +++ b/R/gdal_raster_mosaic.R @@ -22,6 +22,7 @@ #' @param dst_nodata Set nodata values at the destination band level.. `1` to `2147483647` value(s) #' @param hide_nodata Makes the destination band not report the NoData. (Logical) #' @param add_alpha Adds an alpha mask band to the destination when the source raster have none. (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -44,7 +45,8 @@ gdal_raster_mosaic <- function(input = NULL, src_nodata = NULL, dst_nodata = NULL, hide_nodata = FALSE, - add_alpha = FALSE) { + add_alpha = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output)) new_args[["output"]] <- output @@ -71,7 +73,7 @@ gdal_raster_mosaic <- function(input = NULL, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_mosaic", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_overview_add.R b/R/gdal_raster_overview_add.R index b34a0119..9b288abb 100644 --- a/R/gdal_raster_overview_add.R +++ b/R/gdal_raster_overview_add.R @@ -15,6 +15,7 @@ #' @param resampling Resampling method. Choices: "nearest", "average", "cubic", "cubicspline", "lanczos", ... #' @param levels Levels / decimation factors (Integer vector). Minimum: `2` #' @param min_size Maximum width or height of the smallest overview level. (Integer). Minimum: `1` +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -31,7 +32,8 @@ gdal_raster_overview_add <- function(dataset, external = FALSE, resampling = NULL, levels = NULL, - min_size = NULL) { + min_size = NULL, + ...) { new_args <- list() if (!missing(dataset)) new_args[["dataset"]] <- dataset if (!missing(open_option)) new_args[["open_option"]] <- open_option @@ -51,7 +53,7 @@ gdal_raster_overview_add <- function(dataset, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- list(dataset = list(by_default = TRUE, unless_any_of = "external")) .update_intent <- infer_update_intent("gdal_raster_overview_add", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_overview_delete.R b/R/gdal_raster_overview_delete.R index 3ea0e4c2..e31ce7f1 100644 --- a/R/gdal_raster_overview_delete.R +++ b/R/gdal_raster_overview_delete.R @@ -12,6 +12,7 @@ #' @param dataset Dataset (to be updated in-place, unless --read-only) (Dataset path) (required). Can also be a [gdal_job] object to extend a pipeline #' @param open_option Open options (Character vector). Format: `=` (Advanced) #' @param external Delete external overviews (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -23,7 +24,8 @@ #' @export gdal_raster_overview_delete <- function(dataset, open_option = NULL, - external = FALSE) { + external = FALSE, + ...) { new_args <- list() if (!missing(dataset)) new_args[["dataset"]] <- dataset if (!missing(open_option)) new_args[["open_option"]] <- open_option @@ -40,7 +42,7 @@ gdal_raster_overview_delete <- function(dataset, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- list(dataset = list(by_default = TRUE, unless_any_of = "external")) .update_intent <- infer_update_intent("gdal_raster_overview_delete", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_pipeline.R b/R/gdal_raster_pipeline.R index 018221e0..68a87920 100644 --- a/R/gdal_raster_pipeline.R +++ b/R/gdal_raster_pipeline.R @@ -18,6 +18,7 @@ #' @param pipeline Pipeline string (ignored if jobs is provided) #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -37,7 +38,8 @@ gdal_raster_pipeline <- function(jobs = NULL, open_option = NULL, pipeline = NULL, creation_option = NULL, - overwrite = FALSE) { + overwrite = FALSE, + ...) { if (!is.null(jobs)) { if (!is.list(jobs) && !is.vector(jobs)) { @@ -74,6 +76,7 @@ gdal_raster_pipeline <- function(jobs = NULL, overwrite = list(min_count = 0, max_count = 1) ) + args <- .merge_alias_parameters(list(...), args) new_gdal_job(command_path = c("raster", "pipeline"), arguments = args, arg_mapping = .arg_mapping, update_intent = .update_intent) } diff --git a/R/gdal_raster_pixel_info.R b/R/gdal_raster_pixel_info.R index b4746fde..7973450c 100644 --- a/R/gdal_raster_pixel_info.R +++ b/R/gdal_raster_pixel_info.R @@ -18,6 +18,7 @@ #' @param position Pixel position. Format: ` or ` #' @param position_crs CRS of position (Default: `pixel`) #' @param resampling Resampling algorithm for interpolation. Choices: "nearest", "bilinear", "cubic", "cubicspline" (Default: `nearest`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -37,7 +38,8 @@ gdal_raster_pixel_info <- function(input, overview = NULL, position = NULL, position_crs = NULL, - resampling = NULL) { + resampling = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -60,7 +62,7 @@ gdal_raster_pixel_info <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_pixel_info", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_polygonize.R b/R/gdal_raster_polygonize.R index 64be637c..47565884 100644 --- a/R/gdal_raster_polygonize.R +++ b/R/gdal_raster_polygonize.R @@ -24,6 +24,7 @@ #' @param layer Layer name (Default: `polygonize`) #' @param attribute_name Name of the field with the pixel value (Default: `DN`) #' @param connect_diagonal_pixels Consider diagonal pixels as connected (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -47,7 +48,8 @@ gdal_raster_polygonize <- function(input, band = NULL, layer = NULL, attribute_name = NULL, - connect_diagonal_pixels = FALSE) { + connect_diagonal_pixels = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -76,7 +78,7 @@ gdal_raster_polygonize <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_polygonize", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_reclassify.R b/R/gdal_raster_reclassify.R index 7221da16..327423be 100644 --- a/R/gdal_raster_reclassify.R +++ b/R/gdal_raster_reclassify.R @@ -18,6 +18,7 @@ #' @param open_option Open options (Character vector). Format: `=` (Advanced) #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -37,7 +38,8 @@ gdal_raster_reclassify <- function(input, mapping, open_option = NULL, creation_option = NULL, - overwrite = FALSE) { + overwrite = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -60,7 +62,7 @@ gdal_raster_reclassify <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_reclassify", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_reproject.R b/R/gdal_raster_reproject.R index 9a4006db..a4942435 100644 --- a/R/gdal_raster_reproject.R +++ b/R/gdal_raster_reproject.R @@ -30,6 +30,7 @@ #' @param warp_option Warping option(s) (Character vector). Format: `=` (Advanced) #' @param transform_option Transform option(s) (Character vector). Format: `=` (Advanced) #' @param error_threshold Error threshold (Advanced) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -60,7 +61,8 @@ gdal_raster_reproject <- function(input, add_alpha = FALSE, warp_option = NULL, transform_option = NULL, - error_threshold = NULL) { + error_threshold = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -95,7 +97,7 @@ gdal_raster_reproject <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_reproject", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_resize.R b/R/gdal_raster_resize.R index 6fa5df9e..27acd0aa 100644 --- a/R/gdal_raster_resize.R +++ b/R/gdal_raster_resize.R @@ -18,6 +18,7 @@ #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) #' @param resampling Resampling method. Choices: "nearest", "bilinear", "cubic", "cubicspline", "lanczos", ... (Default: `nearest`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -37,7 +38,8 @@ gdal_raster_resize <- function(input, open_option = NULL, creation_option = NULL, overwrite = FALSE, - resampling = NULL) { + resampling = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -60,7 +62,7 @@ gdal_raster_resize <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_resize", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_roughness.R b/R/gdal_raster_roughness.R index 03f7279e..b643ac2b 100644 --- a/R/gdal_raster_roughness.R +++ b/R/gdal_raster_roughness.R @@ -18,6 +18,7 @@ #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) #' @param band Input band (1-based index) (Integer) (Default: `1`) #' @param no_edges Do not try to interpolate values at dataset edges or close to nodata values (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -35,7 +36,8 @@ gdal_raster_roughness <- function(input, creation_option = NULL, overwrite = FALSE, band = NULL, - no_edges = FALSE) { + no_edges = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -58,7 +60,7 @@ gdal_raster_roughness <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_roughness", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_scale.R b/R/gdal_raster_scale.R index cbfd46b1..b4fab73b 100644 --- a/R/gdal_raster_scale.R +++ b/R/gdal_raster_scale.R @@ -24,6 +24,7 @@ #' @param dst_max Maximum value of the destination range #' @param exponent Exponent to apply non-linear scaling with a power function #' @param no_clip Do not clip input values to \[srcmin, srcmax\] (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -48,7 +49,8 @@ gdal_raster_scale <- function(input, dst_min = NULL, dst_max = NULL, exponent = NULL, - no_clip = FALSE) { + no_clip = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -77,7 +79,7 @@ gdal_raster_scale <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_scale", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_select.R b/R/gdal_raster_select.R index c81c5c7b..460bbf8b 100644 --- a/R/gdal_raster_select.R +++ b/R/gdal_raster_select.R @@ -18,6 +18,7 @@ #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) #' @param mask Mask band (1-based index, 'mask', 'mask:' or 'none') +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -36,7 +37,8 @@ gdal_raster_select <- function(input, open_option = NULL, creation_option = NULL, overwrite = FALSE, - mask = NULL) { + mask = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -59,7 +61,7 @@ gdal_raster_select <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_select", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_set_type.R b/R/gdal_raster_set_type.R index 14211801..84a256b0 100644 --- a/R/gdal_raster_set_type.R +++ b/R/gdal_raster_set_type.R @@ -17,6 +17,7 @@ #' @param open_option Open options (Character vector). Format: `=` (Advanced) #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -33,7 +34,8 @@ gdal_raster_set_type <- function(input, output_format = NULL, open_option = NULL, creation_option = NULL, - overwrite = FALSE) { + overwrite = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -55,7 +57,7 @@ gdal_raster_set_type <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_set_type", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_sieve.R b/R/gdal_raster_sieve.R index 3a95caa5..31826e50 100644 --- a/R/gdal_raster_sieve.R +++ b/R/gdal_raster_sieve.R @@ -20,6 +20,7 @@ #' @param band Input band (1-based index) (Integer) #' @param size_threshold Minimum size of polygons to keep (Integer) (Default: `2`) #' @param connect_diagonal_pixels Consider diagonal pixels as connected (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -39,7 +40,8 @@ gdal_raster_sieve <- function(input, mask = NULL, band = NULL, size_threshold = NULL, - connect_diagonal_pixels = FALSE) { + connect_diagonal_pixels = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -64,7 +66,7 @@ gdal_raster_sieve <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_sieve", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_slope.R b/R/gdal_raster_slope.R index a7b2bdc2..e98f11c5 100644 --- a/R/gdal_raster_slope.R +++ b/R/gdal_raster_slope.R @@ -22,6 +22,7 @@ #' @param yscale Ratio of vertical units to horizontal Y axis units. Minimum: `0` #' @param gradient_alg Algorithm used to compute terrain gradient. Choices: "Horn", "ZevenbergenThorne" (Default: `Horn`) #' @param no_edges Do not try to interpolate values at dataset edges or close to nodata values (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -43,7 +44,8 @@ gdal_raster_slope <- function(input, xscale = NULL, yscale = NULL, gradient_alg = NULL, - no_edges = FALSE) { + no_edges = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -70,7 +72,7 @@ gdal_raster_slope <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_slope", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_stack.R b/R/gdal_raster_stack.R index 834797ed..7b922106 100644 --- a/R/gdal_raster_stack.R +++ b/R/gdal_raster_stack.R @@ -21,6 +21,7 @@ #' @param src_nodata Set nodata values for input bands.. `1` to `2147483647` value(s) #' @param dst_nodata Set nodata values at the destination band level.. `1` to `2147483647` value(s) #' @param hide_nodata Makes the destination band not report the NoData. (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -41,7 +42,8 @@ gdal_raster_stack <- function(input = NULL, bbox = NULL, src_nodata = NULL, dst_nodata = NULL, - hide_nodata = FALSE) { + hide_nodata = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output)) new_args[["output"]] <- output @@ -67,7 +69,7 @@ gdal_raster_stack <- function(input = NULL, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_stack", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_tile.R b/R/gdal_raster_tile.R index 669bfb9c..6f073e1d 100644 --- a/R/gdal_raster_tile.R +++ b/R/gdal_raster_tile.R @@ -45,6 +45,7 @@ #' @param title Title of the map (Publication) #' @param copyright Copyright for the map (Publication) #' @param mapml_template Filename of a template mapml file where variables will be substituted (Publication) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -90,7 +91,8 @@ gdal_raster_tile <- function(input, url = NULL, title = NULL, copyright = NULL, - mapml_template = NULL) { + mapml_template = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -140,7 +142,7 @@ gdal_raster_tile <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_tile", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_tpi.R b/R/gdal_raster_tpi.R index cdafc7d6..c94568bc 100644 --- a/R/gdal_raster_tpi.R +++ b/R/gdal_raster_tpi.R @@ -18,6 +18,7 @@ #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) #' @param band Input band (1-based index) (Integer) (Default: `1`) #' @param no_edges Do not try to interpolate values at dataset edges or close to nodata values (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -35,7 +36,8 @@ gdal_raster_tpi <- function(input, creation_option = NULL, overwrite = FALSE, band = NULL, - no_edges = FALSE) { + no_edges = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -58,7 +60,7 @@ gdal_raster_tpi <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_tpi", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_tri.R b/R/gdal_raster_tri.R index 1837a89d..28016121 100644 --- a/R/gdal_raster_tri.R +++ b/R/gdal_raster_tri.R @@ -19,6 +19,7 @@ #' @param band Input band (1-based index) (Integer) (Default: `1`) #' @param algorithm Algorithm to compute TRI. Choices: "Riley", "Wilson" (Default: `Riley`) #' @param no_edges Do not try to interpolate values at dataset edges or close to nodata values (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -37,7 +38,8 @@ gdal_raster_tri <- function(input, overwrite = FALSE, band = NULL, algorithm = NULL, - no_edges = FALSE) { + no_edges = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -61,7 +63,7 @@ gdal_raster_tri <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_tri", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_unscale.R b/R/gdal_raster_unscale.R index 3038de4b..52128e9c 100644 --- a/R/gdal_raster_unscale.R +++ b/R/gdal_raster_unscale.R @@ -17,6 +17,7 @@ #' @param open_option Open options (Character vector). Format: `=` (Advanced) #' @param creation_option Creation option (Character vector). Format: `=` #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -34,7 +35,8 @@ gdal_raster_unscale <- function(input, output_data_type = NULL, open_option = NULL, creation_option = NULL, - overwrite = FALSE) { + overwrite = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -56,7 +58,7 @@ gdal_raster_unscale <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_unscale", merged_args, .update_intent_mapping) diff --git a/R/gdal_raster_viewshed.R b/R/gdal_raster_viewshed.R index a3952eb3..bfe1abff 100644 --- a/R/gdal_raster_viewshed.R +++ b/R/gdal_raster_viewshed.R @@ -28,6 +28,7 @@ #' @param dst_nodata The value to be set for the cells in the output raster that have no data. (Integer). Range: (`0` to `255`) #' @param observer_spacing Cell Spacing between observers (Integer) (Default: `10`). Minimum: `1` #' @param num_threads Number of jobs (or ALL_CPUS) (Default: `3`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_raster_utilities #' @examples @@ -56,7 +57,8 @@ gdal_raster_viewshed <- function(input, out_of_range_value = NULL, dst_nodata = NULL, observer_spacing = NULL, - num_threads = NULL) { + num_threads = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -89,7 +91,7 @@ gdal_raster_viewshed <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_raster_viewshed", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector.R b/R/gdal_vector.R index c7c6a40a..7eb35357 100644 --- a/R/gdal_vector.R +++ b/R/gdal_vector.R @@ -10,6 +10,7 @@ #' #' See \url{https://gdal.org/en/release-3.11/programs/gdal_vector.html} for detailed GDAL documentation. #' @param drivers Display vector driver list as JSON document and exit (Logical). Can also be a [gdal_job] object to extend a pipeline +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -21,7 +22,8 @@ #' # gdal_job_run(job) #' } #' @export -gdal_vector <- function(drivers = FALSE) { +gdal_vector <- function(drivers = FALSE, + ...) { new_args <- list() if (!missing(drivers)) new_args[["drivers"]] <- drivers @@ -36,7 +38,7 @@ gdal_vector <- function(drivers = FALSE) { } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_clip.R b/R/gdal_vector_clip.R index 1871bfa9..7fdc1c3a 100644 --- a/R/gdal_vector_clip.R +++ b/R/gdal_vector_clip.R @@ -31,6 +31,7 @@ #' @param like_sql SELECT statement to run on the 'like' dataset. Format: `SELECT-STATEMENT` #' @param like_layer Name of the layer of the 'like' dataset. Format: `LAYER-NAME` #' @param like_where WHERE SQL clause to run on the 'like' dataset. Format: `WHERE-EXPRESSION` +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -62,7 +63,8 @@ gdal_vector_clip <- function(input, like = NULL, like_sql = NULL, like_layer = NULL, - like_where = NULL) { + like_where = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -98,7 +100,7 @@ gdal_vector_clip <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_clip", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_concat.R b/R/gdal_vector_concat.R index 11a24242..914765e3 100644 --- a/R/gdal_vector_concat.R +++ b/R/gdal_vector_concat.R @@ -28,6 +28,7 @@ #' @param field_strategy How to determine target fields from source fields. Choices: "union", "intersection" (Default: `union`) #' @param src_crs Source CRS #' @param dst_crs Destination CRS +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -55,7 +56,8 @@ gdal_vector_concat <- function(input, mode = NULL, field_strategy = NULL, src_crs = NULL, - dst_crs = NULL) { + dst_crs = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -88,7 +90,7 @@ gdal_vector_concat <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_concat", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_convert.R b/R/gdal_vector_convert.R index 45c4348b..07ed1377 100644 --- a/R/gdal_vector_convert.R +++ b/R/gdal_vector_convert.R @@ -22,6 +22,7 @@ #' @param update Whether to open existing dataset in update mode (Logical) (Default: `false`) #' @param overwrite_layer Whether overwriting existing layer is allowed (Logical) (Default: `false`) #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -43,7 +44,8 @@ gdal_vector_convert <- function(input, overwrite = FALSE, update = FALSE, overwrite_layer = FALSE, - append = FALSE) { + append = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -70,7 +72,7 @@ gdal_vector_convert <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_convert", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_edit.R b/R/gdal_vector_edit.R index 7be314d4..936477c0 100644 --- a/R/gdal_vector_edit.R +++ b/R/gdal_vector_edit.R @@ -29,6 +29,7 @@ #' @param unset_metadata Remove dataset metadata item (Character vector). Format: `KEY` #' @param layer_metadata Add/update layer metadata item (Character vector). Format: `=` #' @param unset_layer_metadata Remove layer metadata item (Character vector). Format: `KEY` +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -58,7 +59,8 @@ gdal_vector_edit <- function(input, metadata = NULL, unset_metadata = NULL, layer_metadata = NULL, - unset_layer_metadata = NULL) { + unset_layer_metadata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -92,7 +94,7 @@ gdal_vector_edit <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- list(dataset = list(by_default = FALSE, if_any_of = "update")) .update_intent <- infer_update_intent("gdal_vector_edit", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_filter.R b/R/gdal_vector_filter.R index 486d498e..fa64a095 100644 --- a/R/gdal_vector_filter.R +++ b/R/gdal_vector_filter.R @@ -25,6 +25,7 @@ #' @param active_layer Set active layer (if not specified, all) #' @param bbox Bounding box as xmin,ymin,xmax,ymax. Exactly `4` value(s) #' @param where Attribute query in a restricted form of the queries used in the SQL WHERE statement. Format: `|@` +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -50,7 +51,8 @@ gdal_vector_filter <- function(input, append = FALSE, active_layer = NULL, bbox = NULL, - where = NULL) { + where = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -80,7 +82,7 @@ gdal_vector_filter <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_filter", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_buffer.R b/R/gdal_vector_geom_buffer.R index 207a2499..27e04dfb 100644 --- a/R/gdal_vector_geom_buffer.R +++ b/R/gdal_vector_geom_buffer.R @@ -30,6 +30,7 @@ #' @param mitre_limit Mitre ratio limit (only affects mitered join style). (Default: `5`). Minimum: `0` #' @param quadrant_segments Number of line segments used to approximate a quarter circle. (Integer) (Default: `8`). Minimum: `1` #' @param side Sets whether the computed buffer should be single-sided or not.. Choices: "both", "left", "right" (Default: `both`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -61,7 +62,8 @@ gdal_vector_geom_buffer <- function(input, join_style = NULL, mitre_limit = NULL, quadrant_segments = NULL, - side = NULL) { + side = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -96,7 +98,7 @@ gdal_vector_geom_buffer <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_buffer", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_explode_collections.R b/R/gdal_vector_geom_explode_collections.R index 8ba56c94..dbc6c35d 100644 --- a/R/gdal_vector_geom_explode_collections.R +++ b/R/gdal_vector_geom_explode_collections.R @@ -26,6 +26,7 @@ #' @param active_geometry Geometry field name to which to restrict the processing (if not specified, all) #' @param geometry_type Geometry type #' @param skip_on_type_mismatch Skip feature when change of feature geometry type failed (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -53,7 +54,8 @@ gdal_vector_geom_explode_collections <- function(input, active_layer = NULL, active_geometry = NULL, geometry_type = NULL, - skip_on_type_mismatch = FALSE) { + skip_on_type_mismatch = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -84,7 +86,7 @@ gdal_vector_geom_explode_collections <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_explode_collections", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_make_valid.R b/R/gdal_vector_geom_make_valid.R index 9c730821..6168ccb8 100644 --- a/R/gdal_vector_geom_make_valid.R +++ b/R/gdal_vector_geom_make_valid.R @@ -26,6 +26,7 @@ #' @param active_geometry Geometry field name to which to restrict the processing (if not specified, all) #' @param method Algorithm to use when repairing invalid geometries.. Choices: "linework", "structure" (Default: `linework`) #' @param keep_lower_dim Keep components of lower dimension after MakeValid() (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -53,7 +54,8 @@ gdal_vector_geom_make_valid <- function(input, active_layer = NULL, active_geometry = NULL, method = NULL, - keep_lower_dim = FALSE) { + keep_lower_dim = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -84,7 +86,7 @@ gdal_vector_geom_make_valid <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_make_valid", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_segmentize.R b/R/gdal_vector_geom_segmentize.R index a8b4fb45..b08418d2 100644 --- a/R/gdal_vector_geom_segmentize.R +++ b/R/gdal_vector_geom_segmentize.R @@ -25,6 +25,7 @@ #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) #' @param active_layer Set active layer (if not specified, all) #' @param active_geometry Geometry field name to which to restrict the processing (if not specified, all) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -51,7 +52,8 @@ gdal_vector_geom_segmentize <- function(input, overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - active_geometry = NULL) { + active_geometry = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -81,7 +83,7 @@ gdal_vector_geom_segmentize <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_segmentize", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_set_type.R b/R/gdal_vector_geom_set_type.R index 16310d1f..f863e704 100644 --- a/R/gdal_vector_geom_set_type.R +++ b/R/gdal_vector_geom_set_type.R @@ -33,6 +33,7 @@ #' @param curve Convert linear geometries to curve types (Logical) #' @param dim Force geometries to the specified dimension. Choices: "XY", "XYZ", "XYM", "XYZM" #' @param skip Skip feature when change of feature geometry type failed (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -67,7 +68,8 @@ gdal_vector_geom_set_type <- function(input, linear = FALSE, curve = FALSE, dim = NULL, - skip = FALSE) { + skip = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -105,7 +107,7 @@ gdal_vector_geom_set_type <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_set_type", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_simplify.R b/R/gdal_vector_geom_simplify.R index 94a05d78..262b75c3 100644 --- a/R/gdal_vector_geom_simplify.R +++ b/R/gdal_vector_geom_simplify.R @@ -25,6 +25,7 @@ #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) #' @param active_layer Set active layer (if not specified, all) #' @param active_geometry Geometry field name to which to restrict the processing (if not specified, all) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -51,7 +52,8 @@ gdal_vector_geom_simplify <- function(input, overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - active_geometry = NULL) { + active_geometry = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -81,7 +83,7 @@ gdal_vector_geom_simplify <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_simplify", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_geom_swap_xy.R b/R/gdal_vector_geom_swap_xy.R index 6579e470..9d8d4877 100644 --- a/R/gdal_vector_geom_swap_xy.R +++ b/R/gdal_vector_geom_swap_xy.R @@ -24,6 +24,7 @@ #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) #' @param active_layer Set active layer (if not specified, all) #' @param active_geometry Geometry field name to which to restrict the processing (if not specified, all) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -49,7 +50,8 @@ gdal_vector_geom_swap_xy <- function(input, overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - active_geometry = NULL) { + active_geometry = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -78,7 +80,7 @@ gdal_vector_geom_swap_xy <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_geom_swap_xy", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_average.R b/R/gdal_vector_grid_average.R index 7e704e70..ecec2eb6 100644 --- a/R/gdal_vector_grid_average.R +++ b/R/gdal_vector_grid_average.R @@ -37,6 +37,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -74,7 +75,8 @@ gdal_vector_grid_average <- function(input, max_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -115,7 +117,7 @@ gdal_vector_grid_average <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_average", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_average_distance.R b/R/gdal_vector_grid_average_distance.R index 44486ab1..a7fe54c6 100644 --- a/R/gdal_vector_grid_average_distance.R +++ b/R/gdal_vector_grid_average_distance.R @@ -37,6 +37,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -73,7 +74,8 @@ gdal_vector_grid_average_distance <- function(input, min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -113,7 +115,7 @@ gdal_vector_grid_average_distance <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_average_distance", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_average_distance_points.R b/R/gdal_vector_grid_average_distance_points.R index 84ad25c0..cf2c1750 100644 --- a/R/gdal_vector_grid_average_distance_points.R +++ b/R/gdal_vector_grid_average_distance_points.R @@ -36,6 +36,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -72,7 +73,8 @@ gdal_vector_grid_average_distance_points <- function(input, min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -112,7 +114,7 @@ gdal_vector_grid_average_distance_points <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_average_distance_points", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_count.R b/R/gdal_vector_grid_count.R index e1b93fb1..0765d0d1 100644 --- a/R/gdal_vector_grid_count.R +++ b/R/gdal_vector_grid_count.R @@ -36,6 +36,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -72,7 +73,8 @@ gdal_vector_grid_count <- function(input, min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -112,7 +114,7 @@ gdal_vector_grid_count <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_count", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_invdist.R b/R/gdal_vector_grid_invdist.R index d2c89b4d..3f6a5ef5 100644 --- a/R/gdal_vector_grid_invdist.R +++ b/R/gdal_vector_grid_invdist.R @@ -39,6 +39,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -78,7 +79,8 @@ gdal_vector_grid_invdist <- function(input, max_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -121,7 +123,7 @@ gdal_vector_grid_invdist <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_invdist", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_invdistnn.R b/R/gdal_vector_grid_invdistnn.R index 09ac35cd..898261b6 100644 --- a/R/gdal_vector_grid_invdistnn.R +++ b/R/gdal_vector_grid_invdistnn.R @@ -36,6 +36,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -72,7 +73,8 @@ gdal_vector_grid_invdistnn <- function(input, max_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -112,7 +114,7 @@ gdal_vector_grid_invdistnn <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_invdistnn", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_linear.R b/R/gdal_vector_grid_linear.R index 5378b64a..65d25083 100644 --- a/R/gdal_vector_grid_linear.R +++ b/R/gdal_vector_grid_linear.R @@ -30,6 +30,7 @@ #' @param zmultiply Multiplication factor for the Z field value (applied after zoffset) (Default: `1`) #' @param radius Radius of the search circle (Default: `Inf`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -60,7 +61,8 @@ gdal_vector_grid_linear <- function(input, zoffset = NULL, zmultiply = NULL, radius = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -94,7 +96,7 @@ gdal_vector_grid_linear <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_linear", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_maximum.R b/R/gdal_vector_grid_maximum.R index c0e7a16d..7faf6f8b 100644 --- a/R/gdal_vector_grid_maximum.R +++ b/R/gdal_vector_grid_maximum.R @@ -36,6 +36,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -72,7 +73,8 @@ gdal_vector_grid_maximum <- function(input, min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -112,7 +114,7 @@ gdal_vector_grid_maximum <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_maximum", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_minimum.R b/R/gdal_vector_grid_minimum.R index 01d21c3c..69600790 100644 --- a/R/gdal_vector_grid_minimum.R +++ b/R/gdal_vector_grid_minimum.R @@ -36,6 +36,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -72,7 +73,8 @@ gdal_vector_grid_minimum <- function(input, min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -112,7 +114,7 @@ gdal_vector_grid_minimum <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_minimum", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_nearest.R b/R/gdal_vector_grid_nearest.R index e2e4828d..1078485a 100644 --- a/R/gdal_vector_grid_nearest.R +++ b/R/gdal_vector_grid_nearest.R @@ -33,6 +33,7 @@ #' @param radius2 Second axis of the search ellipse #' @param angle Angle of search ellipse rotation in degrees (counter clockwise) (Default: `0`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -66,7 +67,8 @@ gdal_vector_grid_nearest <- function(input, radius1 = NULL, radius2 = NULL, angle = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -103,7 +105,7 @@ gdal_vector_grid_nearest <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_nearest", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_grid_range.R b/R/gdal_vector_grid_range.R index aa5710d9..c6822ba3 100644 --- a/R/gdal_vector_grid_range.R +++ b/R/gdal_vector_grid_range.R @@ -36,6 +36,7 @@ #' @param min_points_per_quadrant Minimum number of data points to use per quadrant (Integer) (Default: `0`) #' @param max_points_per_quadrant Maximum number of data points to use per quadrant (Integer) (Default: `2147483647`) #' @param nodata Target nodata value (Default: `0`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -72,7 +73,8 @@ gdal_vector_grid_range <- function(input, min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL) { + nodata = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -112,7 +114,7 @@ gdal_vector_grid_range <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_grid_range", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_info.R b/R/gdal_vector_info.R index 75d3d59c..0a28276f 100644 --- a/R/gdal_vector_info.R +++ b/R/gdal_vector_info.R @@ -20,6 +20,7 @@ #' @param dialect SQL dialect #' @param update Open the dataset in update mode (Logical) #' @param stdout Directly output on stdout (format=text mode only). If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -39,7 +40,8 @@ gdal_vector_info <- function(input, where = NULL, dialect = NULL, update = FALSE, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -64,7 +66,7 @@ gdal_vector_info <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_info", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_pipeline.R b/R/gdal_vector_pipeline.R index d360f061..c5619883 100644 --- a/R/gdal_vector_pipeline.R +++ b/R/gdal_vector_pipeline.R @@ -24,6 +24,7 @@ #' @param update Whether to open existing dataset in update mode (Logical) (Default: `false`) #' @param overwrite_layer Whether overwriting existing layer is allowed (Logical) (Default: `false`) #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -48,7 +49,8 @@ gdal_vector_pipeline <- function(jobs = NULL, overwrite = FALSE, update = FALSE, overwrite_layer = FALSE, - append = FALSE) { + append = FALSE, + ...) { if (!is.null(jobs)) { if (!is.list(jobs) && !is.vector(jobs)) { @@ -97,6 +99,7 @@ gdal_vector_pipeline <- function(jobs = NULL, append = list(min_count = 0, max_count = 1) ) + args <- .merge_alias_parameters(list(...), args) new_gdal_job(command_path = c("vector", "pipeline"), arguments = args, arg_mapping = .arg_mapping, update_intent = .update_intent) } diff --git a/R/gdal_vector_rasterize.R b/R/gdal_vector_rasterize.R index 09c0a1c6..2aade0f1 100644 --- a/R/gdal_vector_rasterize.R +++ b/R/gdal_vector_rasterize.R @@ -38,6 +38,7 @@ #' @param optimization Force the algorithm used (results are identical). Choices: "AUTO", "RASTER", "VECTOR" (Default: `AUTO`) #' @param update Whether to open existing dataset in update mode (Logical) (Default: `false`) #' @param overwrite Whether overwriting existing output is allowed (Logical) (Default: `false`) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -77,7 +78,8 @@ gdal_vector_rasterize <- function(input, size = NULL, optimization = NULL, update = FALSE, - overwrite = FALSE) { + overwrite = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -120,7 +122,7 @@ gdal_vector_rasterize <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_rasterize", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_reproject.R b/R/gdal_vector_reproject.R index 4f6d83e3..3f3bf6e3 100644 --- a/R/gdal_vector_reproject.R +++ b/R/gdal_vector_reproject.R @@ -32,6 +32,7 @@ #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) #' @param active_layer Set active layer (if not specified, all) #' @param src_crs Source CRS +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -58,7 +59,8 @@ gdal_vector_reproject <- function(input, overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - src_crs = NULL) { + src_crs = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -88,7 +90,7 @@ gdal_vector_reproject <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_reproject", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_select.R b/R/gdal_vector_select.R index 9a59a7ad..1a543a47 100644 --- a/R/gdal_vector_select.R +++ b/R/gdal_vector_select.R @@ -26,6 +26,7 @@ #' @param active_layer Set active layer (if not specified, all) #' @param exclude Exclude specified fields (Logical) #' @param ignore_missing_fields Ignore missing fields (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -53,7 +54,8 @@ gdal_vector_select <- function(input, append = FALSE, active_layer = NULL, exclude = FALSE, - ignore_missing_fields = FALSE) { + ignore_missing_fields = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -84,7 +86,7 @@ gdal_vector_select <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_select", merged_args, .update_intent_mapping) diff --git a/R/gdal_vector_sql.R b/R/gdal_vector_sql.R index 4bdf747b..c000b70c 100644 --- a/R/gdal_vector_sql.R +++ b/R/gdal_vector_sql.R @@ -23,6 +23,7 @@ #' @param overwrite_layer Whether overwriting existing layer is allowed (Logical) (Default: `false`) #' @param append Whether appending to existing layer is allowed (Logical) (Default: `false`) #' @param dialect SQL dialect (e.g. OGRSQL, SQLITE) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vector_utilities #' @examples @@ -47,7 +48,8 @@ gdal_vector_sql <- function(input, update = FALSE, overwrite_layer = FALSE, append = FALSE, - dialect = NULL) { + dialect = NULL, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(input_format)) new_args[["input_format"]] <- input_format @@ -75,7 +77,7 @@ gdal_vector_sql <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vector_sql", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_copy.R b/R/gdal_vsi_copy.R index 0421dd6b..2e01e5ff 100644 --- a/R/gdal_vsi_copy.R +++ b/R/gdal_vsi_copy.R @@ -13,6 +13,7 @@ #' @param destination Destination file or directory name (required) #' @param recursive Copy subdirectories recursively (Logical) #' @param skip_errors Skip errors (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -27,7 +28,8 @@ gdal_vsi_copy <- function(source, destination, recursive = FALSE, - skip_errors = FALSE) { + skip_errors = FALSE, + ...) { new_args <- list() if (!missing(source)) new_args[["source"]] <- source if (!missing(destination)) new_args[["destination"]] <- destination @@ -45,7 +47,7 @@ gdal_vsi_copy <- function(source, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_copy", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_delete.R b/R/gdal_vsi_delete.R index c975817f..a6d8d25f 100644 --- a/R/gdal_vsi_delete.R +++ b/R/gdal_vsi_delete.R @@ -11,6 +11,7 @@ #' See \url{https://gdal.org/en/release-3.11/programs/gdal_vsi_delete.html} for detailed GDAL documentation. #' @param filename File or directory name to delete (required). Can also be a [gdal_job] object to extend a pipeline #' @param recursive Delete directories recursively (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -23,7 +24,8 @@ #' } #' @export gdal_vsi_delete <- function(filename, - recursive = FALSE) { + recursive = FALSE, + ...) { new_args <- list() if (!missing(filename)) new_args[["filename"]] <- filename if (!missing(recursive)) new_args[["recursive"]] <- recursive @@ -39,7 +41,7 @@ gdal_vsi_delete <- function(filename, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_delete", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_list.R b/R/gdal_vsi_list.R index e7c77721..658d59ff 100644 --- a/R/gdal_vsi_list.R +++ b/R/gdal_vsi_list.R @@ -17,6 +17,7 @@ #' @param absolute_path Display absolute path (Logical) #' @param tree Use a hierarchical presentation for JSON output (Logical) #' @param stdout Directly output on stdout. If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -35,7 +36,8 @@ gdal_vsi_list <- function(filename, depth = NULL, absolute_path = FALSE, tree = FALSE, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(filename)) new_args[["filename"]] <- filename if (!missing(output_format)) new_args[["output_format"]] <- output_format @@ -57,7 +59,7 @@ gdal_vsi_list <- function(filename, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_list", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_move.R b/R/gdal_vsi_move.R index 728f157d..0b36dc14 100644 --- a/R/gdal_vsi_move.R +++ b/R/gdal_vsi_move.R @@ -11,6 +11,7 @@ #' See \url{https://gdal.org/en/release-3.11/programs/gdal_vsi_move.html} for detailed GDAL documentation. #' @param source Source file or directory name (required). Can also be a [gdal_job] object to extend a pipeline #' @param destination Destination file or directory name (required) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -22,7 +23,8 @@ #' } #' @export gdal_vsi_move <- function(source, - destination) { + destination, + ...) { new_args <- list() if (!missing(source)) new_args[["source"]] <- source if (!missing(destination)) new_args[["destination"]] <- destination @@ -38,7 +40,7 @@ gdal_vsi_move <- function(source, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_move", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_sozip_create.R b/R/gdal_vsi_sozip_create.R index 37701b60..7f7b3c2a 100644 --- a/R/gdal_vsi_sozip_create.R +++ b/R/gdal_vsi_sozip_create.R @@ -19,6 +19,7 @@ #' @param sozip_min_file_size Minimum file size to decide if a file should be seek-optimized. Format: `value in bytes or with K/M/G suffix` (Default: `1 MB`) #' @param content_type Store the Content-Type of the file being added. #' @param stdout Directly output on stdout. If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -39,7 +40,8 @@ gdal_vsi_sozip_create <- function(input, sozip_chunk_size = NULL, sozip_min_file_size = NULL, content_type = NULL, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output)) new_args[["output"]] <- output @@ -63,7 +65,7 @@ gdal_vsi_sozip_create <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_sozip_create", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_sozip_list.R b/R/gdal_vsi_sozip_list.R index 7222c787..fd79c7ce 100644 --- a/R/gdal_vsi_sozip_list.R +++ b/R/gdal_vsi_sozip_list.R @@ -10,6 +10,7 @@ #' #' See \url{https://gdal.org/en/release-3.11/programs/gdal_vsi_sozip_list.html} for detailed GDAL documentation. #' @param input Input ZIP filename (required). Can also be a [gdal_job] object to extend a pipeline +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -21,7 +22,8 @@ #' # gdal_job_run(job) #' } #' @export -gdal_vsi_sozip_list <- function(input) { +gdal_vsi_sozip_list <- function(input, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input @@ -36,7 +38,7 @@ gdal_vsi_sozip_list <- function(input) { } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_sozip_list", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_sozip_optimize.R b/R/gdal_vsi_sozip_optimize.R index 97030941..c636601d 100644 --- a/R/gdal_vsi_sozip_optimize.R +++ b/R/gdal_vsi_sozip_optimize.R @@ -16,6 +16,7 @@ #' @param sozip_chunk_size Chunk size for a seek-optimized file. Format: `value in bytes or with K/M suffix` (Default: `32768`) #' @param sozip_min_file_size Minimum file size to decide if a file should be seek-optimized. Format: `value in bytes or with K/M/G suffix` (Default: `1 MB`) #' @param stdout Directly output on stdout. If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -33,7 +34,8 @@ gdal_vsi_sozip_optimize <- function(input, enable_sozip = NULL, sozip_chunk_size = NULL, sozip_min_file_size = NULL, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(output)) new_args[["output"]] <- output @@ -54,7 +56,7 @@ gdal_vsi_sozip_optimize <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_sozip_optimize", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_sozip_validate.R b/R/gdal_vsi_sozip_validate.R index 400fa45e..b0874161 100644 --- a/R/gdal_vsi_sozip_validate.R +++ b/R/gdal_vsi_sozip_validate.R @@ -11,6 +11,7 @@ #' See \url{https://gdal.org/en/release-3.11/programs/gdal_vsi_sozip_validate.html} for detailed GDAL documentation. #' @param input Input ZIP filename (required). Can also be a [gdal_job] object to extend a pipeline #' @param stdout Directly output on stdout. If enabled, output-string will be empty (Logical) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -23,7 +24,8 @@ #' } #' @export gdal_vsi_sozip_validate <- function(input, - stdout = FALSE) { + stdout = FALSE, + ...) { new_args <- list() if (!missing(input)) new_args[["input"]] <- input if (!missing(stdout)) new_args[["stdout"]] <- stdout @@ -39,7 +41,7 @@ gdal_vsi_sozip_validate <- function(input, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_sozip_validate", merged_args, .update_intent_mapping) diff --git a/R/gdal_vsi_sync.R b/R/gdal_vsi_sync.R index 3d031e19..b39bffc2 100644 --- a/R/gdal_vsi_sync.R +++ b/R/gdal_vsi_sync.R @@ -14,6 +14,7 @@ #' @param recursive Synchronize recursively (Logical) #' @param strategy Synchronization strategy. Choices: "timestamp", "ETag", "overwrite" (Default: `timestamp`) #' @param num_threads Number of jobs (or ALL_CPUS) +#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details. #' @return A [gdal_job] object. #' @family gdal_vsi_utilities #' @examples @@ -29,7 +30,8 @@ gdal_vsi_sync <- function(source, destination, recursive = FALSE, strategy = NULL, - num_threads = NULL) { + num_threads = NULL, + ...) { new_args <- list() if (!missing(source)) new_args[["source"]] <- source if (!missing(destination)) new_args[["destination"]] <- destination @@ -48,7 +50,7 @@ gdal_vsi_sync <- function(source, } - merged_args <- new_args + merged_args <- .merge_alias_parameters(list(...), new_args) .update_intent_mapping <- NULL .update_intent <- infer_update_intent("gdal_vsi_sync", merged_args, .update_intent_mapping) diff --git a/build/generate_gdal_api.R b/build/generate_gdal_api.R index de694290..ff3d965c 100755 --- a/build/generate_gdal_api.R +++ b/build/generate_gdal_api.R @@ -1717,16 +1717,17 @@ generate_function <- function(endpoint, cache = NULL, verbose = FALSE, gdal_vers if (is_pipeline) { # For pipeline functions, add jobs parameter first - args_signature <- paste(c("jobs = NULL", r_args$signature), collapse = ",\n ") + args_signature <- paste(c("jobs = NULL", r_args$signature, "..."), collapse = ",\n ") } else if (is_base_gdal) { # For base gdal function, support shortcuts: gdal(filename), gdal(pipeline), gdal(command_vector) - args_signature <- paste(c("x = NULL", r_args$signature), collapse = ",\n ") + args_signature <- paste(c("x = NULL", r_args$signature, "..."), collapse = ",\n ") } else { # For regular functions, the first positional argument accepts either: # - A gdal_job object (piped from previous operation) # - The actual data (e.g., input filename, dataset) # Detection happens in the function body via inherits(first_arg, "gdal_job") - args_signature <- paste(r_args$signature, collapse = ",\n ") + # Include ... to capture parameter aliases and version-specific parameter names + args_signature <- paste(c(r_args$signature, "..."), collapse = ",\n ") } # Attempt to fetch enriched documentation @@ -2534,6 +2535,9 @@ generate_roxygen_doc <- function(func_name, description, arg_names, enriched_doc } } + # Add documentation for ... parameter (parameter aliases and synonyms) + doc <- paste0(doc, "#' @param ... Parameter aliases and synonyms for backward compatibility. See `?gdal_parameter_aliases` for details.\n") + doc <- paste0(doc, sprintf("#' @return A [gdal_job] object.\n")) # Add family tag if provided @@ -2891,6 +2895,9 @@ generate_function_body <- function(func_name, full_path, input_args, input_outpu ) } } + + # Process ... arguments for base_gdal functions + body_lines <- c(body_lines, " merged_args <- .merge_alias_parameters(list(...), merged_args)") } else { # Handle first argument: can be either a gdal_job (piped) or actual data (fresh call) # Check if first argument exists and is a gdal_job @@ -2922,10 +2929,10 @@ generate_function_body <- function(func_name, full_path, input_args, input_outpu body_lines <- c(body_lines, " }") body_lines <- c(body_lines, "") body_lines <- c(body_lines, "") - body_lines <- c(body_lines, sprintf(" merged_args <- new_args")) + body_lines <- c(body_lines, sprintf(" merged_args <- .merge_alias_parameters(list(...), new_args)")) } else { - # No arguments at all - body_lines <- c(body_lines, " merged_args <- new_args") + # No arguments at all - still process ... for alias parameters + body_lines <- c(body_lines, " merged_args <- .merge_alias_parameters(list(...), new_args)") } } @@ -2980,6 +2987,8 @@ generate_function_body <- function(func_name, full_path, input_args, input_outpu } if (is_pipeline) { + # Process ... arguments for pipeline functions too + body_lines <- c(body_lines, " args <- .merge_alias_parameters(list(...), args)") body_lines <- c( body_lines, sprintf(" new_gdal_job(command_path = %s, arguments = args, arg_mapping = .arg_mapping, update_intent = .update_intent)", path_json) diff --git a/examples/01_raster_pipeline_save_load.R b/examples/01_raster_pipeline_save_load.R index 7da230f6..cdd35520 100644 --- a/examples/01_raster_pipeline_save_load.R +++ b/examples/01_raster_pipeline_save_load.R @@ -28,19 +28,11 @@ cat(" Output directory:", output_dir, "\n\n") # Create a realistic raster processing pipeline # Reproject to UTM -> Scale values -> Convert to COG -if (gdal_check_version("3.13", op = ">=")) { - pipeline <- gdal_raster_reproject( - input = sample_raster, - output = file.path(output_dir, "reprojected.tif"), - output_crs = "EPSG:32618" # UTM Zone 18N - ) -} else { - pipeline <- gdal_raster_reproject( - input = sample_raster, - output = file.path(output_dir, "reprojected.tif"), - dst_crs = "EPSG:32618" # UTM Zone 18N - ) -} |> +pipeline <- gdal_raster_reproject( + input = sample_raster, + output = file.path(output_dir, "reprojected.tif"), + output_crs = "EPSG:32618" # UTM Zone 18N +) |> gdal_raster_scale( src_min = 0, src_max = 100, diff --git a/examples/02_vector_pipeline_metadata.R b/examples/02_vector_pipeline_metadata.R index ec2c1421..247a513e 100644 --- a/examples/02_vector_pipeline_metadata.R +++ b/examples/02_vector_pipeline_metadata.R @@ -31,8 +31,7 @@ cat(" Output directory:", output_dir, "\n\n") pipeline <- gdal_vector_reproject( input = sample_vector, output = output_vector, - output_crs = if (gdal_check_version("3.13", op = ">=")) "EPSG:3857" else NULL, - dst_crs = if (gdal_check_version("3.13", op = ">=")) NULL else "EPSG:3857" + output_crs = "EPSG:3857" # Web Mercator ) |> gdal_vector_convert( output = file.path(output_dir, "final_mapunits.gpkg"), diff --git a/inst/GDAL_PARAMETER_MAPPINGS.json b/inst/GDAL_PARAMETER_MAPPINGS.json new file mode 100644 index 00000000..753f56df --- /dev/null +++ b/inst/GDAL_PARAMETER_MAPPINGS.json @@ -0,0 +1,28 @@ +{ + "parameter_aliases": { + "dst_crs": { + "new_name": "output_crs", + "version_introduced": "3.12.2", + "description": "Renamed to output_crs for consistency" + }, + "dataset": { + "new_name": "input", + "version_introduced": "3.12.2", + "description": "Renamed to input for consistency" + } + }, + "command_deprecations": { + "gdal_raster_reproject": { + "affected_parameters": ["dst_crs"], + "version_changed": "3.12.2" + }, + "gdal_vector_reproject": { + "affected_parameters": ["dst_crs"], + "version_changed": "3.12.2" + }, + "gdal_raster_overview_add": { + "affected_parameters": ["dataset"], + "version_changed": "3.12.2" + } + } +} diff --git a/man/dot-merge_alias_parameters.Rd b/man/dot-merge_alias_parameters.Rd new file mode 100644 index 00000000..79afd335 --- /dev/null +++ b/man/dot-merge_alias_parameters.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/core-parameter-aliases.R +\name{.merge_alias_parameters} +\alias{.merge_alias_parameters} +\title{Merge Parameter Aliases and Synonyms} +\usage{ +.merge_alias_parameters(dots, named_args, gdal_version = NULL) +} +\arguments{ +\item{dots}{List from \code{...} containing potential aliases/synonyms} + +\item{named_args}{Named parameters from function signature} + +\item{gdal_version}{GDAL version string (optional, auto-detected if NULL)} +} +\value{ +List of merged parameters with aliases and synonyms resolved +} +\description{ +Handle parameter aliases (version-aware) and synonyms (always valid). +Routes old parameter names based on GDAL version; normalizes synonyms to canonical names. +} +\keyword{internal} diff --git a/man/gdal.Rd b/man/gdal.Rd index 6b409be2..a18b0740 100644 --- a/man/gdal.Rd +++ b/man/gdal.Rd @@ -4,12 +4,14 @@ \alias{gdal} \title{Main gdal entry point} \usage{ -gdal(x = NULL, drivers = FALSE) +gdal(x = NULL, drivers = FALSE, ...) } \arguments{ \item{x}{A filename (for 'gdal info'), a pipeline string (for 'gdal pipeline'), a command vector, or a gdal_job object from a piped operation} \item{drivers}{Display driver list as JSON document (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_driver_gpkg_repack.Rd b/man/gdal_driver_gpkg_repack.Rd index 2738359e..47c10d17 100644 --- a/man/gdal_driver_gpkg_repack.Rd +++ b/man/gdal_driver_gpkg_repack.Rd @@ -4,10 +4,12 @@ \alias{gdal_driver_gpkg_repack} \title{repack: Repack/vacuum in-place a GeoPackage dataset} \usage{ -gdal_driver_gpkg_repack(dataset) +gdal_driver_gpkg_repack(dataset, ...) } \arguments{ \item{dataset}{GeoPackage dataset (Dataset path) (required). Can also be a \link{gdal_job} object to extend a pipeline} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_driver_gti_create.Rd b/man/gdal_driver_gti_create.Rd index a1d96b20..029cba83 100644 --- a/man/gdal_driver_gti_create.Rd +++ b/man/gdal_driver_gti_create.Rd @@ -31,7 +31,8 @@ gdal_driver_gti_create( nodata = NULL, color_interpretation = NULL, mask = FALSE, - fetch_metadata = NULL + fetch_metadata = NULL, + ... ) } \arguments{ @@ -88,6 +89,8 @@ gdal_driver_gti_create( \item{mask}{Defines that the virtual mosaic has a mask band (Logical)} \item{fetch_metadata}{Fetch a metadata item from source rasters and write it as a field in the index. (Character vector). Format: \verb{,,}} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_driver_openfilegdb_repack.Rd b/man/gdal_driver_openfilegdb_repack.Rd index 72fd5274..2d64a8d0 100644 --- a/man/gdal_driver_openfilegdb_repack.Rd +++ b/man/gdal_driver_openfilegdb_repack.Rd @@ -4,10 +4,12 @@ \alias{gdal_driver_openfilegdb_repack} \title{repack: Repack a FileGeoDatabase dataset} \usage{ -gdal_driver_openfilegdb_repack(dataset) +gdal_driver_openfilegdb_repack(dataset, ...) } \arguments{ \item{dataset}{FileGeoDatabase dataset (Dataset path) (required). Can also be a \link{gdal_job} object to extend a pipeline} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_driver_pdf_list_layers.Rd b/man/gdal_driver_pdf_list_layers.Rd index 1b88a3ea..3bd34f5b 100644 --- a/man/gdal_driver_pdf_list_layers.Rd +++ b/man/gdal_driver_pdf_list_layers.Rd @@ -4,12 +4,14 @@ \alias{gdal_driver_pdf_list_layers} \title{list-layers: List layers of a PDF dataset} \usage{ -gdal_driver_pdf_list_layers(input, output_format = NULL) +gdal_driver_pdf_list_layers(input, output_format = NULL, ...) } \arguments{ \item{input}{Input raster or vector dataset (Dataset path) (required). Can also be a \link{gdal_job} object to extend a pipeline} \item{output_format}{Output format. Choices: "json", "text" (Default: \code{json})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_mdim.Rd b/man/gdal_mdim.Rd index 8af32467..90694846 100644 --- a/man/gdal_mdim.Rd +++ b/man/gdal_mdim.Rd @@ -4,10 +4,12 @@ \alias{gdal_mdim} \title{mdim: Multidimensional commands} \usage{ -gdal_mdim(drivers = FALSE) +gdal_mdim(drivers = FALSE, ...) } \arguments{ \item{drivers}{Display multidimensional driver list as JSON document (Logical). Can also be a \link{gdal_job} object to extend a pipeline} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_mdim_convert.Rd b/man/gdal_mdim_convert.Rd index ff6254f8..7cde198d 100644 --- a/man/gdal_mdim_convert.Rd +++ b/man/gdal_mdim_convert.Rd @@ -17,7 +17,8 @@ gdal_mdim_convert( group = NULL, subset = NULL, scale_axes = NULL, - strict = FALSE + strict = FALSE, + ... ) } \arguments{ @@ -46,6 +47,8 @@ gdal_mdim_convert( \item{scale_axes}{Applies a integral scale factor to one or several dimensions (Character vector). Format: \code{SCALEAXES-SPEC}} \item{strict}{Turn warnings into failures. (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_mdim_info.Rd b/man/gdal_mdim_info.Rd index 26057488..fec733ff 100644 --- a/man/gdal_mdim_info.Rd +++ b/man/gdal_mdim_info.Rd @@ -13,7 +13,8 @@ gdal_mdim_info( limit = NULL, array_option = NULL, stats = FALSE, - stdout = FALSE + stdout = FALSE, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_mdim_info( \item{stats}{Read and display image statistics. (Logical)} \item{stdout}{Directly output on stdout. If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_parameter_aliases.Rd b/man/gdal_parameter_aliases.Rd new file mode 100644 index 00000000..7a753206 --- /dev/null +++ b/man/gdal_parameter_aliases.Rd @@ -0,0 +1,53 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/core-gdal_parameter_aliases.R +\name{gdal_parameter_aliases} +\alias{gdal_parameter_aliases} +\title{GDAL Parameter Aliases and Synonyms} +\description{ +Documentation of parameter aliases and synonyms supported by gdalcli functions +for backward compatibility across GDAL versions. +} +\details{ +All gdalcli wrapper functions support flexible parameter naming through two mechanisms: + +\strong{Version-aware aliases}: Old GDAL parameter names (introduced before RFC 104) +automatically route to modern names on GDAL 3.12+, where parameter standardization +(RFC 104) introduced the new naming scheme. Backward compatibility is maintained +throughout: pass either old or new names; routing is automatic. + +Common aliases (RFC 104 - GDAL 3.12+): +\itemize{ +\item \code{dst_crs} or \code{t_srs} -> \code{output_crs} (standardized CRS destination parameter) +\item \code{src_crs} or \code{s_srs} -> \code{input_crs} (standardized CRS source parameter) +\item \code{dataset} -> \code{input} (unified input parameter naming) +\item \code{a_srs} -> \code{override_crs} (CRS override without reprojection) +} + +\strong{Parameter synonyms}: Alternative names for the same parameter that are always +valid, regardless of GDAL version. Useful for shorter or more familiar parameter names. + +Common synonyms: +\itemize{ +\item \code{output_format}: also accepts \code{format}, \code{of}, \code{output-format} +\item \code{input_layer}: also accepts \code{layer}, \code{input-layer} +} + +Users can pass parameters using either old or new names; the system automatically +handles routing to the correct names for the installed GDAL version. +} +\examples{ +\dontrun{ +# All of these are equivalent across GDAL versions +job1 <- gdal_raster_reproject(input = "in.tif", output_crs = "EPSG:4326") +job2 <- gdal_raster_reproject(input = "in.tif", dst_crs = "EPSG:4326") # Old name +job3 <- gdal_raster_reproject(input = "in.tif", t_srs = "EPSG:4326") # Legacy gdalwarp name + +# Parameter synonyms +conv1 <- gdal_raster_convert(input = "in.tif", output_format = "COG") +conv2 <- gdal_raster_convert(input = "in.tif", format = "COG") # Shorter +conv3 <- gdal_raster_convert(input = "in.tif", of = "COG") # Abbreviation +} +} +\seealso{ +\code{\link[=gdal_call]{gdal_call()}} for dynamic command invocation, \code{\link[=gdal_check_version]{gdal_check_version()}} for version-specific logic +} diff --git a/man/gdal_raster.Rd b/man/gdal_raster.Rd index 1545fc4a..9f2b961a 100644 --- a/man/gdal_raster.Rd +++ b/man/gdal_raster.Rd @@ -4,10 +4,12 @@ \alias{gdal_raster} \title{raster: Raster commands} \usage{ -gdal_raster(drivers = FALSE) +gdal_raster(drivers = FALSE, ...) } \arguments{ \item{drivers}{Display raster driver list as JSON document (Logical). Can also be a \link{gdal_job} object to extend a pipeline} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_aspect.Rd b/man/gdal_raster_aspect.Rd index b687ecbc..1e6aa809 100644 --- a/man/gdal_raster_aspect.Rd +++ b/man/gdal_raster_aspect.Rd @@ -16,7 +16,8 @@ gdal_raster_aspect( convention = NULL, gradient_alg = NULL, zero_for_flat = FALSE, - no_edges = FALSE + no_edges = FALSE, + ... ) } \arguments{ @@ -43,6 +44,8 @@ gdal_raster_aspect( \item{zero_for_flat}{Whether to output zero for flat areas (Logical)} \item{no_edges}{Do not try to interpolate values at dataset edges or close to nodata values (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_calc.Rd b/man/gdal_raster_calc.Rd index 2507b022..51f6bd6a 100644 --- a/man/gdal_raster_calc.Rd +++ b/man/gdal_raster_calc.Rd @@ -13,7 +13,8 @@ gdal_raster_calc( creation_option = NULL, overwrite = FALSE, no_check_srs = FALSE, - no_check_extent = FALSE + no_check_extent = FALSE, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_calc( \item{no_check_srs}{Do not check consistency of input spatial reference systems (Logical)} \item{no_check_extent}{Do not check consistency of input extents (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_clean_collar.Rd b/man/gdal_raster_clean_collar.Rd index cb2c1f93..22eb76e5 100644 --- a/man/gdal_raster_clean_collar.Rd +++ b/man/gdal_raster_clean_collar.Rd @@ -18,7 +18,8 @@ gdal_raster_clean_collar( pixel_distance = NULL, add_alpha = FALSE, add_mask = FALSE, - algorithm = NULL + algorithm = NULL, + ... ) } \arguments{ @@ -49,6 +50,8 @@ gdal_raster_clean_collar( \item{add_mask}{Adds a mask band to the output dataset. (Logical)} \item{algorithm}{Algorithm to apply. Choices: "floodfill", "twopasses" (Default: \code{floodfill})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_clip.Rd b/man/gdal_raster_clip.Rd index 0b4de507..566ca537 100644 --- a/man/gdal_raster_clip.Rd +++ b/man/gdal_raster_clip.Rd @@ -22,7 +22,8 @@ gdal_raster_clip( like_where = NULL, only_bbox = FALSE, allow_bbox_outside_source = FALSE, - add_alpha = FALSE + add_alpha = FALSE, + ... ) } \arguments{ @@ -61,6 +62,8 @@ gdal_raster_clip( \item{allow_bbox_outside_source}{Allow clipping box to include pixels outside input dataset (Logical)} \item{add_alpha}{Adds an alpha mask band to the destination when the source raster have none. (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_color_map.Rd b/man/gdal_raster_color_map.Rd index 37754388..50473872 100644 --- a/man/gdal_raster_color_map.Rd +++ b/man/gdal_raster_color_map.Rd @@ -15,7 +15,8 @@ gdal_raster_color_map( band = NULL, color_map = NULL, add_alpha = FALSE, - color_selection = NULL + color_selection = NULL, + ... ) } \arguments{ @@ -40,6 +41,8 @@ gdal_raster_color_map( \item{add_alpha}{Adds an alpha mask band to the destination. (Logical)} \item{color_selection}{How to compute output colors from input values. Choices: "interpolate", "exact", "nearest" (Default: \code{interpolate})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_contour.Rd b/man/gdal_raster_contour.Rd index 9a833180..366e2261 100644 --- a/man/gdal_raster_contour.Rd +++ b/man/gdal_raster_contour.Rd @@ -25,7 +25,8 @@ gdal_raster_contour( offset = NULL, polygonize = FALSE, group_transactions = NULL, - overwrite = FALSE + overwrite = FALSE, + ... ) } \arguments{ @@ -70,6 +71,8 @@ gdal_raster_contour( \item{group_transactions}{Group n features per transaction (default 100 000) (Integer). Minimum: \code{0}} \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_convert.Rd b/man/gdal_raster_convert.Rd index 6446ef15..ab366f07 100644 --- a/man/gdal_raster_convert.Rd +++ b/man/gdal_raster_convert.Rd @@ -12,7 +12,8 @@ gdal_raster_convert( open_option = NULL, creation_option = NULL, overwrite = FALSE, - append = FALSE + append = FALSE, + ... ) } \arguments{ @@ -31,6 +32,8 @@ gdal_raster_convert( \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} \item{append}{Append as a subdataset to existing output (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_create.Rd b/man/gdal_raster_create.Rd index a97ffad7..828e256c 100644 --- a/man/gdal_raster_create.Rd +++ b/man/gdal_raster_create.Rd @@ -22,7 +22,8 @@ gdal_raster_create( bbox = NULL, metadata = NULL, copy_metadata = FALSE, - copy_overviews = FALSE + copy_overviews = FALSE, + ... ) } \arguments{ @@ -61,6 +62,8 @@ gdal_raster_create( \item{copy_metadata}{Copy metadata from input dataset (Logical)} \item{copy_overviews}{Create same overview levels as input dataset (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_edit.Rd b/man/gdal_raster_edit.Rd index 47506991..e5085e79 100644 --- a/man/gdal_raster_edit.Rd +++ b/man/gdal_raster_edit.Rd @@ -14,7 +14,8 @@ gdal_raster_edit( unset_metadata = NULL, stats = FALSE, approx_stats = FALSE, - hist = FALSE + hist = FALSE, + ... ) } \arguments{ @@ -37,6 +38,8 @@ gdal_raster_edit( \item{approx_stats}{Compute statistics, using a subset of pixels (Logical)} \item{hist}{Compute histogram (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_fill_nodata.Rd b/man/gdal_raster_fill_nodata.Rd index db8de889..e5d00711 100644 --- a/man/gdal_raster_fill_nodata.Rd +++ b/man/gdal_raster_fill_nodata.Rd @@ -15,7 +15,8 @@ gdal_raster_fill_nodata( max_distance = NULL, smoothing_iterations = NULL, mask = NULL, - strategy = NULL + strategy = NULL, + ... ) } \arguments{ @@ -40,6 +41,8 @@ gdal_raster_fill_nodata( \item{mask}{Use the first band of the specified file as a validity mask (zero is invalid, non-zero is valid). (Dataset path)} \item{strategy}{By default, pixels are interpolated using an inverse distance weighting (invdist). It is also possible to choose a nearest neighbour (nearest) strategy.. Choices: "invdist", "nearest" (Default: \code{invdist})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_footprint.Rd b/man/gdal_raster_footprint.Rd index f990d500..b02aa325 100644 --- a/man/gdal_raster_footprint.Rd +++ b/man/gdal_raster_footprint.Rd @@ -29,7 +29,8 @@ gdal_raster_footprint( max_points = NULL, location_field = NULL, no_location_field = FALSE, - absolute_path = FALSE + absolute_path = FALSE, + ... ) } \arguments{ @@ -82,6 +83,8 @@ gdal_raster_footprint( \item{no_location_field}{Disable creating a field with the path of the input dataset (Logical)} \item{absolute_path}{Whether the path to the input dataset should be stored as an absolute path (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_hillshade.Rd b/man/gdal_raster_hillshade.Rd index 584d25d9..504f889f 100644 --- a/man/gdal_raster_hillshade.Rd +++ b/man/gdal_raster_hillshade.Rd @@ -20,7 +20,8 @@ gdal_raster_hillshade( altitude = NULL, gradient_alg = NULL, variant = NULL, - no_edges = FALSE + no_edges = FALSE, + ... ) } \arguments{ @@ -55,6 +56,8 @@ gdal_raster_hillshade( \item{variant}{Variant of the hillshading algorithm. Choices: "regular", "combined", "multidirectional", "Igor" (Default: \code{regular})} \item{no_edges}{Do not try to interpolate values at dataset edges or close to nodata values (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_index.Rd b/man/gdal_raster_index.Rd index 43be8f49..f9e69e74 100644 --- a/man/gdal_raster_index.Rd +++ b/man/gdal_raster_index.Rd @@ -24,7 +24,8 @@ gdal_raster_index( location_name = NULL, absolute_path = FALSE, dst_crs = NULL, - metadata = NULL + metadata = NULL, + ... ) } \arguments{ @@ -67,6 +68,8 @@ gdal_raster_index( \item{dst_crs}{Destination CRS} \item{metadata}{Add dataset metadata item (Character vector). Format: \verb{=}} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_info.Rd b/man/gdal_raster_info.Rd index e8d984cb..c7aa2c13 100644 --- a/man/gdal_raster_info.Rd +++ b/man/gdal_raster_info.Rd @@ -23,7 +23,8 @@ gdal_raster_info( no_nodata = FALSE, no_mask = FALSE, subdataset = NULL, - stdout = FALSE + stdout = FALSE, + ... ) } \arguments{ @@ -64,6 +65,8 @@ gdal_raster_info( \item{subdataset}{Use subdataset of specified index (starting at 1), instead of the source dataset itself (Integer). Minimum: \code{1} (Esoteric)} \item{stdout}{Directly output on stdout (format=text mode only). If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_mosaic.Rd b/man/gdal_raster_mosaic.Rd index 606b8181..e691f05f 100644 --- a/man/gdal_raster_mosaic.Rd +++ b/man/gdal_raster_mosaic.Rd @@ -17,7 +17,8 @@ gdal_raster_mosaic( src_nodata = NULL, dst_nodata = NULL, hide_nodata = FALSE, - add_alpha = FALSE + add_alpha = FALSE, + ... ) } \arguments{ @@ -46,6 +47,8 @@ gdal_raster_mosaic( \item{hide_nodata}{Makes the destination band not report the NoData. (Logical)} \item{add_alpha}{Adds an alpha mask band to the destination when the source raster have none. (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_overview_add.Rd b/man/gdal_raster_overview_add.Rd index 08d4da7e..63d40bd0 100644 --- a/man/gdal_raster_overview_add.Rd +++ b/man/gdal_raster_overview_add.Rd @@ -10,7 +10,8 @@ gdal_raster_overview_add( external = FALSE, resampling = NULL, levels = NULL, - min_size = NULL + min_size = NULL, + ... ) } \arguments{ @@ -25,6 +26,8 @@ gdal_raster_overview_add( \item{levels}{Levels / decimation factors (Integer vector). Minimum: \code{2}} \item{min_size}{Maximum width or height of the smallest overview level. (Integer). Minimum: \code{1}} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_overview_delete.Rd b/man/gdal_raster_overview_delete.Rd index 35b1290a..5c39e837 100644 --- a/man/gdal_raster_overview_delete.Rd +++ b/man/gdal_raster_overview_delete.Rd @@ -4,7 +4,7 @@ \alias{gdal_raster_overview_delete} \title{delete: Deleting overviews} \usage{ -gdal_raster_overview_delete(dataset, open_option = NULL, external = FALSE) +gdal_raster_overview_delete(dataset, open_option = NULL, external = FALSE, ...) } \arguments{ \item{dataset}{Dataset (to be updated in-place, unless --read-only) (Dataset path) (required). Can also be a \link{gdal_job} object to extend a pipeline} @@ -12,6 +12,8 @@ gdal_raster_overview_delete(dataset, open_option = NULL, external = FALSE) \item{open_option}{Open options (Character vector). Format: \verb{=} (Advanced)} \item{external}{Delete external overviews (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_pipeline.Rd b/man/gdal_raster_pipeline.Rd index 716a7b9a..01f4dc87 100644 --- a/man/gdal_raster_pipeline.Rd +++ b/man/gdal_raster_pipeline.Rd @@ -13,7 +13,8 @@ gdal_raster_pipeline( open_option = NULL, pipeline = NULL, creation_option = NULL, - overwrite = FALSE + overwrite = FALSE, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_pipeline( \item{creation_option}{Creation option (Character vector). Format: \verb{=}} \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_pixel_info.Rd b/man/gdal_raster_pixel_info.Rd index 9ef52cf4..566c21e5 100644 --- a/man/gdal_raster_pixel_info.Rd +++ b/man/gdal_raster_pixel_info.Rd @@ -13,7 +13,8 @@ gdal_raster_pixel_info( overview = NULL, position = NULL, position_crs = NULL, - resampling = NULL + resampling = NULL, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_pixel_info( \item{position_crs}{CRS of position (Default: \code{pixel})} \item{resampling}{Resampling algorithm for interpolation. Choices: "nearest", "bilinear", "cubic", "cubicspline" (Default: \code{nearest})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_polygonize.Rd b/man/gdal_raster_polygonize.Rd index a7b1596f..c84aa13c 100644 --- a/man/gdal_raster_polygonize.Rd +++ b/man/gdal_raster_polygonize.Rd @@ -19,7 +19,8 @@ gdal_raster_polygonize( band = NULL, layer = NULL, attribute_name = NULL, - connect_diagonal_pixels = FALSE + connect_diagonal_pixels = FALSE, + ... ) } \arguments{ @@ -52,6 +53,8 @@ gdal_raster_polygonize( \item{attribute_name}{Name of the field with the pixel value (Default: \code{DN})} \item{connect_diagonal_pixels}{Consider diagonal pixels as connected (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_reclassify.Rd b/man/gdal_raster_reclassify.Rd index c5596e39..70e6cd12 100644 --- a/man/gdal_raster_reclassify.Rd +++ b/man/gdal_raster_reclassify.Rd @@ -13,7 +13,8 @@ gdal_raster_reclassify( mapping, open_option = NULL, creation_option = NULL, - overwrite = FALSE + overwrite = FALSE, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_reclassify( \item{creation_option}{Creation option (Character vector). Format: \verb{=}} \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_reproject.Rd b/man/gdal_raster_reproject.Rd index 671d79b9..8e86c308 100644 --- a/man/gdal_raster_reproject.Rd +++ b/man/gdal_raster_reproject.Rd @@ -25,7 +25,8 @@ gdal_raster_reproject( add_alpha = FALSE, warp_option = NULL, transform_option = NULL, - error_threshold = NULL + error_threshold = NULL, + ... ) } \arguments{ @@ -70,6 +71,8 @@ gdal_raster_reproject( \item{transform_option}{Transform option(s) (Character vector). Format: \verb{=} (Advanced)} \item{error_threshold}{Error threshold (Advanced)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_resize.Rd b/man/gdal_raster_resize.Rd index db92926f..65cb95a7 100644 --- a/man/gdal_raster_resize.Rd +++ b/man/gdal_raster_resize.Rd @@ -13,7 +13,8 @@ gdal_raster_resize( open_option = NULL, creation_option = NULL, overwrite = FALSE, - resampling = NULL + resampling = NULL, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_resize( \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} \item{resampling}{Resampling method. Choices: "nearest", "bilinear", "cubic", "cubicspline", "lanczos", ... (Default: \code{nearest})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_roughness.Rd b/man/gdal_raster_roughness.Rd index 85340679..72d8d7be 100644 --- a/man/gdal_raster_roughness.Rd +++ b/man/gdal_raster_roughness.Rd @@ -13,7 +13,8 @@ gdal_raster_roughness( creation_option = NULL, overwrite = FALSE, band = NULL, - no_edges = FALSE + no_edges = FALSE, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_roughness( \item{band}{Input band (1-based index) (Integer) (Default: \code{1})} \item{no_edges}{Do not try to interpolate values at dataset edges or close to nodata values (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_scale.Rd b/man/gdal_raster_scale.Rd index 66ddf1ff..e9487ac6 100644 --- a/man/gdal_raster_scale.Rd +++ b/man/gdal_raster_scale.Rd @@ -19,7 +19,8 @@ gdal_raster_scale( dst_min = NULL, dst_max = NULL, exponent = NULL, - no_clip = FALSE + no_clip = FALSE, + ... ) } \arguments{ @@ -52,6 +53,8 @@ gdal_raster_scale( \item{exponent}{Exponent to apply non-linear scaling with a power function} \item{no_clip}{Do not clip input values to [srcmin, srcmax] (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_select.Rd b/man/gdal_raster_select.Rd index f7cf339e..6ae1dffd 100644 --- a/man/gdal_raster_select.Rd +++ b/man/gdal_raster_select.Rd @@ -13,7 +13,8 @@ gdal_raster_select( open_option = NULL, creation_option = NULL, overwrite = FALSE, - mask = NULL + mask = NULL, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_select( \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} \item{mask}{Mask band (1-based index, 'mask', 'mask:\if{html}{\out{}}' or 'none')} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_set_type.Rd b/man/gdal_raster_set_type.Rd index c495e3c4..8aece995 100644 --- a/man/gdal_raster_set_type.Rd +++ b/man/gdal_raster_set_type.Rd @@ -12,7 +12,8 @@ gdal_raster_set_type( output_format = NULL, open_option = NULL, creation_option = NULL, - overwrite = FALSE + overwrite = FALSE, + ... ) } \arguments{ @@ -31,6 +32,8 @@ gdal_raster_set_type( \item{creation_option}{Creation option (Character vector). Format: \verb{=}} \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_sieve.Rd b/man/gdal_raster_sieve.Rd index 16128db5..b1e417a7 100644 --- a/man/gdal_raster_sieve.Rd +++ b/man/gdal_raster_sieve.Rd @@ -15,7 +15,8 @@ gdal_raster_sieve( mask = NULL, band = NULL, size_threshold = NULL, - connect_diagonal_pixels = FALSE + connect_diagonal_pixels = FALSE, + ... ) } \arguments{ @@ -40,6 +41,8 @@ gdal_raster_sieve( \item{size_threshold}{Minimum size of polygons to keep (Integer) (Default: \code{2})} \item{connect_diagonal_pixels}{Consider diagonal pixels as connected (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_slope.Rd b/man/gdal_raster_slope.Rd index ebabe993..beaf539a 100644 --- a/man/gdal_raster_slope.Rd +++ b/man/gdal_raster_slope.Rd @@ -17,7 +17,8 @@ gdal_raster_slope( xscale = NULL, yscale = NULL, gradient_alg = NULL, - no_edges = FALSE + no_edges = FALSE, + ... ) } \arguments{ @@ -46,6 +47,8 @@ gdal_raster_slope( \item{gradient_alg}{Algorithm used to compute terrain gradient. Choices: "Horn", "ZevenbergenThorne" (Default: \code{Horn})} \item{no_edges}{Do not try to interpolate values at dataset edges or close to nodata values (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_stack.Rd b/man/gdal_raster_stack.Rd index cd69baca..933a1b4a 100644 --- a/man/gdal_raster_stack.Rd +++ b/man/gdal_raster_stack.Rd @@ -16,7 +16,8 @@ gdal_raster_stack( bbox = NULL, src_nodata = NULL, dst_nodata = NULL, - hide_nodata = FALSE + hide_nodata = FALSE, + ... ) } \arguments{ @@ -43,6 +44,8 @@ gdal_raster_stack( \item{dst_nodata}{Set nodata values at the destination band level.. \code{1} to \code{2147483647} value(s)} \item{hide_nodata}{Makes the destination band not report the NoData. (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_tile.Rd b/man/gdal_raster_tile.Rd index 0cc5dec5..f66a52fc 100644 --- a/man/gdal_raster_tile.Rd +++ b/man/gdal_raster_tile.Rd @@ -40,7 +40,8 @@ gdal_raster_tile( url = NULL, title = NULL, copyright = NULL, - mapml_template = NULL + mapml_template = NULL, + ... ) } \arguments{ @@ -115,6 +116,8 @@ gdal_raster_tile( \item{copyright}{Copyright for the map (Publication)} \item{mapml_template}{Filename of a template mapml file where variables will be substituted (Publication)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_tpi.Rd b/man/gdal_raster_tpi.Rd index cfa5a5d6..5d39da3a 100644 --- a/man/gdal_raster_tpi.Rd +++ b/man/gdal_raster_tpi.Rd @@ -13,7 +13,8 @@ gdal_raster_tpi( creation_option = NULL, overwrite = FALSE, band = NULL, - no_edges = FALSE + no_edges = FALSE, + ... ) } \arguments{ @@ -34,6 +35,8 @@ gdal_raster_tpi( \item{band}{Input band (1-based index) (Integer) (Default: \code{1})} \item{no_edges}{Do not try to interpolate values at dataset edges or close to nodata values (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_tri.Rd b/man/gdal_raster_tri.Rd index 8d0f42bb..95e95d1c 100644 --- a/man/gdal_raster_tri.Rd +++ b/man/gdal_raster_tri.Rd @@ -14,7 +14,8 @@ gdal_raster_tri( overwrite = FALSE, band = NULL, algorithm = NULL, - no_edges = FALSE + no_edges = FALSE, + ... ) } \arguments{ @@ -37,6 +38,8 @@ gdal_raster_tri( \item{algorithm}{Algorithm to compute TRI. Choices: "Riley", "Wilson" (Default: \code{Riley})} \item{no_edges}{Do not try to interpolate values at dataset edges or close to nodata values (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_unscale.Rd b/man/gdal_raster_unscale.Rd index 716f69d3..c4223fc7 100644 --- a/man/gdal_raster_unscale.Rd +++ b/man/gdal_raster_unscale.Rd @@ -12,7 +12,8 @@ gdal_raster_unscale( output_data_type = NULL, open_option = NULL, creation_option = NULL, - overwrite = FALSE + overwrite = FALSE, + ... ) } \arguments{ @@ -31,6 +32,8 @@ gdal_raster_unscale( \item{creation_option}{Creation option (Character vector). Format: \verb{=}} \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_raster_viewshed.Rd b/man/gdal_raster_viewshed.Rd index 780505ec..141c3944 100644 --- a/man/gdal_raster_viewshed.Rd +++ b/man/gdal_raster_viewshed.Rd @@ -23,7 +23,8 @@ gdal_raster_viewshed( out_of_range_value = NULL, dst_nodata = NULL, observer_spacing = NULL, - num_threads = NULL + num_threads = NULL, + ... ) } \arguments{ @@ -64,6 +65,8 @@ gdal_raster_viewshed( \item{observer_spacing}{Cell Spacing between observers (Integer) (Default: \code{10}). Minimum: \code{1}} \item{num_threads}{Number of jobs (or ALL_CPUS) (Default: \code{3})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector.Rd b/man/gdal_vector.Rd index 2e249d05..7725f4cb 100644 --- a/man/gdal_vector.Rd +++ b/man/gdal_vector.Rd @@ -4,10 +4,12 @@ \alias{gdal_vector} \title{vector: Vector commands} \usage{ -gdal_vector(drivers = FALSE) +gdal_vector(drivers = FALSE, ...) } \arguments{ \item{drivers}{Display vector driver list as JSON document and exit (Logical). Can also be a \link{gdal_job} object to extend a pipeline} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_clip.Rd b/man/gdal_vector_clip.Rd index 54256b0b..6e8013a3 100644 --- a/man/gdal_vector_clip.Rd +++ b/man/gdal_vector_clip.Rd @@ -26,7 +26,8 @@ gdal_vector_clip( like = NULL, like_sql = NULL, like_layer = NULL, - like_where = NULL + like_where = NULL, + ... ) } \arguments{ @@ -73,6 +74,8 @@ gdal_vector_clip( \item{like_layer}{Name of the layer of the 'like' dataset. Format: \code{LAYER-NAME}} \item{like_where}{WHERE SQL clause to run on the 'like' dataset. Format: \code{WHERE-EXPRESSION}} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_concat.Rd b/man/gdal_vector_concat.Rd index 90de7487..5f4193e7 100644 --- a/man/gdal_vector_concat.Rd +++ b/man/gdal_vector_concat.Rd @@ -23,7 +23,8 @@ gdal_vector_concat( mode = NULL, field_strategy = NULL, src_crs = NULL, - dst_crs = NULL + dst_crs = NULL, + ... ) } \arguments{ @@ -64,6 +65,8 @@ gdal_vector_concat( \item{src_crs}{Source CRS} \item{dst_crs}{Destination CRS} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_convert.Rd b/man/gdal_vector_convert.Rd index c47fbcf9..18ee5362 100644 --- a/man/gdal_vector_convert.Rd +++ b/man/gdal_vector_convert.Rd @@ -17,7 +17,8 @@ gdal_vector_convert( overwrite = FALSE, update = FALSE, overwrite_layer = FALSE, - append = FALSE + append = FALSE, + ... ) } \arguments{ @@ -46,6 +47,8 @@ gdal_vector_convert( \item{overwrite_layer}{Whether overwriting existing layer is allowed (Logical) (Default: \code{false})} \item{append}{Whether appending to existing layer is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_edit.Rd b/man/gdal_vector_edit.Rd index 977d94c8..28ce6605 100644 --- a/man/gdal_vector_edit.Rd +++ b/man/gdal_vector_edit.Rd @@ -24,7 +24,8 @@ gdal_vector_edit( metadata = NULL, unset_metadata = NULL, layer_metadata = NULL, - unset_layer_metadata = NULL + unset_layer_metadata = NULL, + ... ) } \arguments{ @@ -67,6 +68,8 @@ gdal_vector_edit( \item{layer_metadata}{Add/update layer metadata item (Character vector). Format: \verb{=}} \item{unset_layer_metadata}{Remove layer metadata item (Character vector). Format: \code{KEY}} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_filter.Rd b/man/gdal_vector_filter.Rd index aefb2d65..b1ad823a 100644 --- a/man/gdal_vector_filter.Rd +++ b/man/gdal_vector_filter.Rd @@ -20,7 +20,8 @@ gdal_vector_filter( append = FALSE, active_layer = NULL, bbox = NULL, - where = NULL + where = NULL, + ... ) } \arguments{ @@ -55,6 +56,8 @@ gdal_vector_filter( \item{bbox}{Bounding box as xmin,ymin,xmax,ymax. Exactly \code{4} value(s)} \item{where}{Attribute query in a restricted form of the queries used in the SQL WHERE statement. Format: \verb{|@}} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_buffer.Rd b/man/gdal_vector_geom_buffer.Rd index b86afac1..cba6a2e3 100644 --- a/man/gdal_vector_geom_buffer.Rd +++ b/man/gdal_vector_geom_buffer.Rd @@ -25,7 +25,8 @@ gdal_vector_geom_buffer( join_style = NULL, mitre_limit = NULL, quadrant_segments = NULL, - side = NULL + side = NULL, + ... ) } \arguments{ @@ -70,6 +71,8 @@ gdal_vector_geom_buffer( \item{quadrant_segments}{Number of line segments used to approximate a quarter circle. (Integer) (Default: \code{8}). Minimum: \code{1}} \item{side}{Sets whether the computed buffer should be single-sided or not.. Choices: "both", "left", "right" (Default: \code{both})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_explode_collections.Rd b/man/gdal_vector_geom_explode_collections.Rd index 83095543..eacccfa9 100644 --- a/man/gdal_vector_geom_explode_collections.Rd +++ b/man/gdal_vector_geom_explode_collections.Rd @@ -21,7 +21,8 @@ gdal_vector_geom_explode_collections( active_layer = NULL, active_geometry = NULL, geometry_type = NULL, - skip_on_type_mismatch = FALSE + skip_on_type_mismatch = FALSE, + ... ) } \arguments{ @@ -58,6 +59,8 @@ gdal_vector_geom_explode_collections( \item{geometry_type}{Geometry type} \item{skip_on_type_mismatch}{Skip feature when change of feature geometry type failed (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_make_valid.Rd b/man/gdal_vector_geom_make_valid.Rd index 06ad2632..79401115 100644 --- a/man/gdal_vector_geom_make_valid.Rd +++ b/man/gdal_vector_geom_make_valid.Rd @@ -21,7 +21,8 @@ gdal_vector_geom_make_valid( active_layer = NULL, active_geometry = NULL, method = NULL, - keep_lower_dim = FALSE + keep_lower_dim = FALSE, + ... ) } \arguments{ @@ -58,6 +59,8 @@ gdal_vector_geom_make_valid( \item{method}{Algorithm to use when repairing invalid geometries.. Choices: "linework", "structure" (Default: \code{linework})} \item{keep_lower_dim}{Keep components of lower dimension after MakeValid() (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_segmentize.Rd b/man/gdal_vector_geom_segmentize.Rd index d2db69d6..d0bf5d4d 100644 --- a/man/gdal_vector_geom_segmentize.Rd +++ b/man/gdal_vector_geom_segmentize.Rd @@ -20,7 +20,8 @@ gdal_vector_geom_segmentize( overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - active_geometry = NULL + active_geometry = NULL, + ... ) } \arguments{ @@ -55,6 +56,8 @@ gdal_vector_geom_segmentize( \item{active_layer}{Set active layer (if not specified, all)} \item{active_geometry}{Geometry field name to which to restrict the processing (if not specified, all)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_set_type.Rd b/man/gdal_vector_geom_set_type.Rd index 4042a026..1a213872 100644 --- a/man/gdal_vector_geom_set_type.Rd +++ b/man/gdal_vector_geom_set_type.Rd @@ -28,7 +28,8 @@ gdal_vector_geom_set_type( linear = FALSE, curve = FALSE, dim = NULL, - skip = FALSE + skip = FALSE, + ... ) } \arguments{ @@ -79,6 +80,8 @@ gdal_vector_geom_set_type( \item{dim}{Force geometries to the specified dimension. Choices: "XY", "XYZ", "XYM", "XYZM"} \item{skip}{Skip feature when change of feature geometry type failed (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_simplify.Rd b/man/gdal_vector_geom_simplify.Rd index 296eb97f..d3ca55a2 100644 --- a/man/gdal_vector_geom_simplify.Rd +++ b/man/gdal_vector_geom_simplify.Rd @@ -20,7 +20,8 @@ gdal_vector_geom_simplify( overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - active_geometry = NULL + active_geometry = NULL, + ... ) } \arguments{ @@ -55,6 +56,8 @@ gdal_vector_geom_simplify( \item{active_layer}{Set active layer (if not specified, all)} \item{active_geometry}{Geometry field name to which to restrict the processing (if not specified, all)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_geom_swap_xy.Rd b/man/gdal_vector_geom_swap_xy.Rd index e581434a..296fa279 100644 --- a/man/gdal_vector_geom_swap_xy.Rd +++ b/man/gdal_vector_geom_swap_xy.Rd @@ -19,7 +19,8 @@ gdal_vector_geom_swap_xy( overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - active_geometry = NULL + active_geometry = NULL, + ... ) } \arguments{ @@ -52,6 +53,8 @@ gdal_vector_geom_swap_xy( \item{active_layer}{Set active layer (if not specified, all)} \item{active_geometry}{Geometry field name to which to restrict the processing (if not specified, all)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_average.Rd b/man/gdal_vector_grid_average.Rd index 3def4485..d81f3db9 100644 --- a/man/gdal_vector_grid_average.Rd +++ b/man/gdal_vector_grid_average.Rd @@ -31,7 +31,8 @@ gdal_vector_grid_average( max_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -88,6 +89,8 @@ gdal_vector_grid_average( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_average_distance.Rd b/man/gdal_vector_grid_average_distance.Rd index 633f819f..30d0c27c 100644 --- a/man/gdal_vector_grid_average_distance.Rd +++ b/man/gdal_vector_grid_average_distance.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_average_distance( min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_average_distance( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_average_distance_points.Rd b/man/gdal_vector_grid_average_distance_points.Rd index db120d6d..8727539a 100644 --- a/man/gdal_vector_grid_average_distance_points.Rd +++ b/man/gdal_vector_grid_average_distance_points.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_average_distance_points( min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_average_distance_points( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_count.Rd b/man/gdal_vector_grid_count.Rd index ab67ff02..b1204839 100644 --- a/man/gdal_vector_grid_count.Rd +++ b/man/gdal_vector_grid_count.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_count( min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_count( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_invdist.Rd b/man/gdal_vector_grid_invdist.Rd index 5161b1b8..bbc33960 100644 --- a/man/gdal_vector_grid_invdist.Rd +++ b/man/gdal_vector_grid_invdist.Rd @@ -33,7 +33,8 @@ gdal_vector_grid_invdist( max_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -94,6 +95,8 @@ gdal_vector_grid_invdist( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_invdistnn.Rd b/man/gdal_vector_grid_invdistnn.Rd index a5df552e..53e9af44 100644 --- a/man/gdal_vector_grid_invdistnn.Rd +++ b/man/gdal_vector_grid_invdistnn.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_invdistnn( max_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_invdistnn( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_linear.Rd b/man/gdal_vector_grid_linear.Rd index 1ebd8f88..841e827f 100644 --- a/man/gdal_vector_grid_linear.Rd +++ b/man/gdal_vector_grid_linear.Rd @@ -24,7 +24,8 @@ gdal_vector_grid_linear( zoffset = NULL, zmultiply = NULL, radius = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -67,6 +68,8 @@ gdal_vector_grid_linear( \item{radius}{Radius of the search circle (Default: \code{Inf})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_maximum.Rd b/man/gdal_vector_grid_maximum.Rd index a7a6685a..ce2742b8 100644 --- a/man/gdal_vector_grid_maximum.Rd +++ b/man/gdal_vector_grid_maximum.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_maximum( min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_maximum( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_minimum.Rd b/man/gdal_vector_grid_minimum.Rd index 6da565a1..deb170ba 100644 --- a/man/gdal_vector_grid_minimum.Rd +++ b/man/gdal_vector_grid_minimum.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_minimum( min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_minimum( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_nearest.Rd b/man/gdal_vector_grid_nearest.Rd index 2def4ba3..5838d67c 100644 --- a/man/gdal_vector_grid_nearest.Rd +++ b/man/gdal_vector_grid_nearest.Rd @@ -27,7 +27,8 @@ gdal_vector_grid_nearest( radius1 = NULL, radius2 = NULL, angle = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -76,6 +77,8 @@ gdal_vector_grid_nearest( \item{angle}{Angle of search ellipse rotation in degrees (counter clockwise) (Default: \code{0})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_grid_range.Rd b/man/gdal_vector_grid_range.Rd index aa471b70..5e2e6a4e 100644 --- a/man/gdal_vector_grid_range.Rd +++ b/man/gdal_vector_grid_range.Rd @@ -30,7 +30,8 @@ gdal_vector_grid_range( min_points = NULL, min_points_per_quadrant = NULL, max_points_per_quadrant = NULL, - nodata = NULL + nodata = NULL, + ... ) } \arguments{ @@ -85,6 +86,8 @@ gdal_vector_grid_range( \item{max_points_per_quadrant}{Maximum number of data points to use per quadrant (Integer) (Default: \code{2147483647})} \item{nodata}{Target nodata value (Default: \code{0})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_info.Rd b/man/gdal_vector_info.Rd index 6785d118..c72aea85 100644 --- a/man/gdal_vector_info.Rd +++ b/man/gdal_vector_info.Rd @@ -15,7 +15,8 @@ gdal_vector_info( where = NULL, dialect = NULL, update = FALSE, - stdout = FALSE + stdout = FALSE, + ... ) } \arguments{ @@ -40,6 +41,8 @@ gdal_vector_info( \item{update}{Open the dataset in update mode (Logical)} \item{stdout}{Directly output on stdout (format=text mode only). If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_pipeline.Rd b/man/gdal_vector_pipeline.Rd index 559ba642..e08210e3 100644 --- a/man/gdal_vector_pipeline.Rd +++ b/man/gdal_vector_pipeline.Rd @@ -19,7 +19,8 @@ gdal_vector_pipeline( overwrite = FALSE, update = FALSE, overwrite_layer = FALSE, - append = FALSE + append = FALSE, + ... ) } \arguments{ @@ -52,6 +53,8 @@ gdal_vector_pipeline( \item{overwrite_layer}{Whether overwriting existing layer is allowed (Logical) (Default: \code{false})} \item{append}{Whether appending to existing layer is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_rasterize.Rd b/man/gdal_vector_rasterize.Rd index a8c37486..ca366dab 100644 --- a/man/gdal_vector_rasterize.Rd +++ b/man/gdal_vector_rasterize.Rd @@ -33,7 +33,8 @@ gdal_vector_rasterize( size = NULL, optimization = NULL, update = FALSE, - overwrite = FALSE + overwrite = FALSE, + ... ) } \arguments{ @@ -94,6 +95,8 @@ gdal_vector_rasterize( \item{update}{Whether to open existing dataset in update mode (Logical) (Default: \code{false})} \item{overwrite}{Whether overwriting existing output is allowed (Logical) (Default: \code{false})} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_reproject.Rd b/man/gdal_vector_reproject.Rd index 1c89d748..4556b8ca 100644 --- a/man/gdal_vector_reproject.Rd +++ b/man/gdal_vector_reproject.Rd @@ -20,7 +20,8 @@ gdal_vector_reproject( overwrite_layer = FALSE, append = FALSE, active_layer = NULL, - src_crs = NULL + src_crs = NULL, + ... ) } \arguments{ @@ -55,6 +56,8 @@ gdal_vector_reproject( \item{active_layer}{Set active layer (if not specified, all)} \item{src_crs}{Source CRS} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_select.Rd b/man/gdal_vector_select.Rd index bbb040eb..fb37b4cd 100644 --- a/man/gdal_vector_select.Rd +++ b/man/gdal_vector_select.Rd @@ -21,7 +21,8 @@ gdal_vector_select( append = FALSE, active_layer = NULL, exclude = FALSE, - ignore_missing_fields = FALSE + ignore_missing_fields = FALSE, + ... ) } \arguments{ @@ -58,6 +59,8 @@ gdal_vector_select( \item{exclude}{Exclude specified fields (Logical)} \item{ignore_missing_fields}{Ignore missing fields (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vector_sql.Rd b/man/gdal_vector_sql.Rd index d438284a..667ea84c 100644 --- a/man/gdal_vector_sql.Rd +++ b/man/gdal_vector_sql.Rd @@ -18,7 +18,8 @@ gdal_vector_sql( update = FALSE, overwrite_layer = FALSE, append = FALSE, - dialect = NULL + dialect = NULL, + ... ) } \arguments{ @@ -49,6 +50,8 @@ gdal_vector_sql( \item{append}{Whether appending to existing layer is allowed (Logical) (Default: \code{false})} \item{dialect}{SQL dialect (e.g. OGRSQL, SQLITE)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_copy.Rd b/man/gdal_vsi_copy.Rd index 985fb1bf..31d64f45 100644 --- a/man/gdal_vsi_copy.Rd +++ b/man/gdal_vsi_copy.Rd @@ -4,7 +4,7 @@ \alias{gdal_vsi_copy} \title{copy: Copy files located on GDAL Virtual System Interface (VSI)} \usage{ -gdal_vsi_copy(source, destination, recursive = FALSE, skip_errors = FALSE) +gdal_vsi_copy(source, destination, recursive = FALSE, skip_errors = FALSE, ...) } \arguments{ \item{source}{Source file or directory name (required). Can also be a \link{gdal_job} object to extend a pipeline} @@ -14,6 +14,8 @@ gdal_vsi_copy(source, destination, recursive = FALSE, skip_errors = FALSE) \item{recursive}{Copy subdirectories recursively (Logical)} \item{skip_errors}{Skip errors (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_delete.Rd b/man/gdal_vsi_delete.Rd index c3bb0bd0..8601ce0a 100644 --- a/man/gdal_vsi_delete.Rd +++ b/man/gdal_vsi_delete.Rd @@ -4,12 +4,14 @@ \alias{gdal_vsi_delete} \title{delete: Delete files located on GDAL Virtual System Interface (VSI)} \usage{ -gdal_vsi_delete(filename, recursive = FALSE) +gdal_vsi_delete(filename, recursive = FALSE, ...) } \arguments{ \item{filename}{File or directory name to delete (required). Can also be a \link{gdal_job} object to extend a pipeline} \item{recursive}{Delete directories recursively (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_list.Rd b/man/gdal_vsi_list.Rd index 196d87a4..d454c24b 100644 --- a/man/gdal_vsi_list.Rd +++ b/man/gdal_vsi_list.Rd @@ -12,7 +12,8 @@ gdal_vsi_list( depth = NULL, absolute_path = FALSE, tree = FALSE, - stdout = FALSE + stdout = FALSE, + ... ) } \arguments{ @@ -31,6 +32,8 @@ gdal_vsi_list( \item{tree}{Use a hierarchical presentation for JSON output (Logical)} \item{stdout}{Directly output on stdout. If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_move.Rd b/man/gdal_vsi_move.Rd index 58f19e93..a8936cb8 100644 --- a/man/gdal_vsi_move.Rd +++ b/man/gdal_vsi_move.Rd @@ -4,12 +4,14 @@ \alias{gdal_vsi_move} \title{move: Move/rename a file/directory located on GDAL Virtual System Interface (VSI)} \usage{ -gdal_vsi_move(source, destination) +gdal_vsi_move(source, destination, ...) } \arguments{ \item{source}{Source file or directory name (required). Can also be a \link{gdal_job} object to extend a pipeline} \item{destination}{Destination file or directory name (required)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_sozip_create.Rd b/man/gdal_vsi_sozip_create.Rd index f2687b4c..204daffb 100644 --- a/man/gdal_vsi_sozip_create.Rd +++ b/man/gdal_vsi_sozip_create.Rd @@ -14,7 +14,8 @@ gdal_vsi_sozip_create( sozip_chunk_size = NULL, sozip_min_file_size = NULL, content_type = NULL, - stdout = FALSE + stdout = FALSE, + ... ) } \arguments{ @@ -37,6 +38,8 @@ gdal_vsi_sozip_create( \item{content_type}{Store the Content-Type of the file being added.} \item{stdout}{Directly output on stdout. If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_sozip_list.Rd b/man/gdal_vsi_sozip_list.Rd index 27123613..8420a3be 100644 --- a/man/gdal_vsi_sozip_list.Rd +++ b/man/gdal_vsi_sozip_list.Rd @@ -4,10 +4,12 @@ \alias{gdal_vsi_sozip_list} \title{list: List content of a ZIP file, with SOZIP related information} \usage{ -gdal_vsi_sozip_list(input) +gdal_vsi_sozip_list(input, ...) } \arguments{ \item{input}{Input ZIP filename (required). Can also be a \link{gdal_job} object to extend a pipeline} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_sozip_optimize.Rd b/man/gdal_vsi_sozip_optimize.Rd index 84609b5d..438c4216 100644 --- a/man/gdal_vsi_sozip_optimize.Rd +++ b/man/gdal_vsi_sozip_optimize.Rd @@ -11,7 +11,8 @@ gdal_vsi_sozip_optimize( enable_sozip = NULL, sozip_chunk_size = NULL, sozip_min_file_size = NULL, - stdout = FALSE + stdout = FALSE, + ... ) } \arguments{ @@ -28,6 +29,8 @@ gdal_vsi_sozip_optimize( \item{sozip_min_file_size}{Minimum file size to decide if a file should be seek-optimized. Format: \verb{value in bytes or with K/M/G suffix} (Default: \verb{1 MB})} \item{stdout}{Directly output on stdout. If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_sozip_validate.Rd b/man/gdal_vsi_sozip_validate.Rd index dacd3cae..c60f7e3d 100644 --- a/man/gdal_vsi_sozip_validate.Rd +++ b/man/gdal_vsi_sozip_validate.Rd @@ -4,12 +4,14 @@ \alias{gdal_vsi_sozip_validate} \title{validate: Validate a ZIP file, possibly using SOZIP optimization} \usage{ -gdal_vsi_sozip_validate(input, stdout = FALSE) +gdal_vsi_sozip_validate(input, stdout = FALSE, ...) } \arguments{ \item{input}{Input ZIP filename (required). Can also be a \link{gdal_job} object to extend a pipeline} \item{stdout}{Directly output on stdout. If enabled, output-string will be empty (Logical)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/man/gdal_vsi_sync.Rd b/man/gdal_vsi_sync.Rd index b8f33d19..ec06bc04 100644 --- a/man/gdal_vsi_sync.Rd +++ b/man/gdal_vsi_sync.Rd @@ -9,7 +9,8 @@ gdal_vsi_sync( destination, recursive = FALSE, strategy = NULL, - num_threads = NULL + num_threads = NULL, + ... ) } \arguments{ @@ -22,6 +23,8 @@ gdal_vsi_sync( \item{strategy}{Synchronization strategy. Choices: "timestamp", "ETag", "overwrite" (Default: \code{timestamp})} \item{num_threads}{Number of jobs (or ALL_CPUS)} + +\item{...}{Parameter aliases and synonyms for backward compatibility. See \code{?gdal_parameter_aliases} for details.} } \value{ A \link{gdal_job} object. diff --git a/tests/testthat/test_checkpoint.R b/tests/testthat/test_checkpoint.R index 971d0906..6be55173 100644 --- a/tests/testthat/test_checkpoint.R +++ b/tests/testthat/test_checkpoint.R @@ -79,7 +79,7 @@ test_that("checkpoint detects pipeline changes", { checkpoint_state <- .save_checkpoint(pipeline1, checkpoint_dir, 1, NULL) # Try to resume with a different pipeline - if (gdal_check_version("3.13", op = ">=")) { + if (gdal_check_version("3.12.2", op = ">=")) { job2 <- gdal_raster_reproject(input = "test.tif", output_crs = "EPSG:4326") } else { job2 <- gdal_raster_reproject(input = "test.tif", dst_crs = "EPSG:4326") @@ -179,7 +179,7 @@ test_that("multiple checkpoints can be saved sequentially", { test_that("pipeline with checkpoint parameter can be created", { job1 <- gdal_raster_info(input = "test.tif") - if (gdal_check_version("3.13", op = ">=")) { + if (gdal_check_version("3.12.2", op = ">=")) { job2 <- gdal_raster_reproject(input = "test.tif", output_crs = "EPSG:4326") } else { job2 <- gdal_raster_reproject(input = "test.tif", dst_crs = "EPSG:4326") @@ -227,7 +227,7 @@ test_that("checkpoint preserves all metadata fields", { on.exit(unlink(checkpoint_dir, recursive = TRUE)) job1 <- gdal_raster_info(input = "input.tif") - if (gdal_check_version("3.13", op = ">=")) { + if (gdal_check_version("3.12.2", op = ">=")) { job2 <- gdal_raster_reproject(input = "input.tif", output_crs = "EPSG:4326") } else { job2 <- gdal_raster_reproject(input = "input.tif", dst_crs = "EPSG:4326") @@ -259,7 +259,7 @@ test_that("checkpoint supports pipeline with multiple operations", { on.exit(unlink(checkpoint_dir, recursive = TRUE)) # Create a multi-step pipeline - if (gdal_check_version("3.13", op = ">=")) { + if (gdal_check_version("3.12.2", op = ">=")) { job1 <- gdal_raster_reproject( input = "input.tif", output_crs = "EPSG:4326" diff --git a/tests/testthat/test_gdal_call.R b/tests/testthat/test_gdal_call.R index 4f455288..fd108bf2 100644 --- a/tests/testthat/test_gdal_call.R +++ b/tests/testthat/test_gdal_call.R @@ -110,7 +110,7 @@ test_that("gdal_call works with NULL modifiers (default)", { test_that("gdal_call invokes function by character name", { # Build args based on GDAL version args <- list(levels = c(2, 4, 8)) - if (gdal_check_version("3.13", op = ">=")) { + if (gdal_check_version("3.12.2", op = ">=")) { args$input <- "test.tif" } else { args$dataset <- "test.tif" diff --git a/tests/testthat/test_pipeline.R b/tests/testthat/test_pipeline.R index 9032e62a..224a90a6 100644 --- a/tests/testthat/test_pipeline.R +++ b/tests/testthat/test_pipeline.R @@ -1,25 +1,14 @@ -# ====== Version-Aware Helper Functions for GDAL 3.13+ Compatibility ====== -# GDAL 3.13.0 renamed --dst-crs to --output-crs (and similar for dst-* params) -# These helpers ensure tests work with both 3.11/3.12 (dst_crs) and 3.13+ (output_crs) +# Version-agnostic helper functions +# Modern parameter names work on all GDAL versions via automatic routing .make_raster_reproject_job <- function(input, crs, output = NULL) { if (is.null(output)) output <- tempfile(fileext = ".tif") - - if (gdal_check_version("3.13", op = ">=")) { - gdal_raster_reproject(input = input, output_crs = crs, output = output) - } else { - gdal_raster_reproject(input = input, dst_crs = crs, output = output) - } + gdal_raster_reproject(input = input, output_crs = crs, output = output) } .make_vector_reproject_job <- function(input, crs, output = NULL) { if (is.null(output)) output <- tempfile(fileext = ".shp") - - if (gdal_check_version("3.13", op = ">=")) { - gdal_vector_reproject(input = input, output_crs = crs, output = output) - } else { - gdal_vector_reproject(input = input, dst_crs = crs, output = output) - } + gdal_vector_reproject(input = input, output_crs = crs, output = output) } # ======================================================================== diff --git a/tests/testthat/test_step_mappings.R b/tests/testthat/test_step_mappings.R index 727481cb..44f36ce9 100644 --- a/tests/testthat/test_step_mappings.R +++ b/tests/testthat/test_step_mappings.R @@ -1,11 +1,11 @@ -# ====== Version-Aware Helper Functions for GDAL 3.13+ Compatibility ====== -# GDAL 3.13.0 renamed --dst-crs to --output-crs (and similar for dst-* params) -# These helpers ensure tests work with both 3.11/3.12 (dst_crs) and 3.13+ (output_crs) +# ====== Version-Aware Helper Functions for GDAL 3.12.2+ Compatibility ====== +# GDAL 3.12.2 renamed --dst-crs to --output-crs (and similar for dst-* params) +# These helpers ensure tests work with both 3.11/3.12.0 (dst_crs) and 3.12.2+ (output_crs) .make_raster_reproject_job <- function(input, crs, output = NULL) { if (is.null(output)) output <- tempfile(fileext = ".tif") - if (gdal_check_version("3.13", op = ">=")) { + if (gdal_check_version("3.12.2", op = ">=")) { gdal_raster_reproject(input = input, output_crs = crs, output = output) } else { gdal_raster_reproject(input = input, dst_crs = crs, output = output) diff --git a/vignettes/pipeline-serialization.Rmd b/vignettes/pipeline-serialization.Rmd index a7bb71be..a4be33a1 100644 --- a/vignettes/pipeline-serialization.Rmd +++ b/vignettes/pipeline-serialization.Rmd @@ -55,17 +55,10 @@ The hybrid format is the default and recommended choice for most gdalcli workflo library(gdalcli) # Create a processing pipeline -if (gdal_check_version("3.13", op = ">=")) { - pipeline <- gdal_raster_reproject( - input = "input.tif", - output_crs = "EPSG:32618" - ) -} else { - pipeline <- gdal_raster_reproject( - input = "input.tif", - dst_crs = "EPSG:32618" - ) -} |> +pipeline <- gdal_raster_reproject( + input = "input.tif", + output_crs = "EPSG:32618" +) |> gdal_raster_scale(src_min = 0, src_max = 255) # Create a temporary file for demonstration @@ -152,17 +145,10 @@ The pure GDALG format is the minimal, RFC 104-compliant specification. Use this ```{r pure-gdalg-create} # Convert an existing pipeline to GDALG -if (gdal_check_version("3.13", op = ">=")) { - pipeline <- gdal_raster_reproject( - input = "input.tif", - output_crs = "EPSG:32618" - ) -} else { - pipeline <- gdal_raster_reproject( - input = "input.tif", - dst_crs = "EPSG:32618" - ) -} +pipeline <- gdal_raster_reproject( + input = "input.tif", + output_crs = "EPSG:32618" +) gdalg <- as_gdalg(pipeline) ``` @@ -267,17 +253,10 @@ The hybrid format enables perfect round-trip preservation: ```{r round-trip, eval=FALSE} # Original pipeline -if (gdal_check_version("3.13", op = ">=")) { - original <- gdal_raster_reproject( - input = "input.tif", - output_crs = "EPSG:32618" - ) -} else { - original <- gdal_raster_reproject( - input = "input.tif", - dst_crs = "EPSG:32618" - ) -} +original <- gdal_raster_reproject( + input = "input.tif", + output_crs = "EPSG:32618" +) # Save to hybrid format gdal_save_pipeline(original, "workflow.gdalcli.json")