mdim_info: Report structure and content of a multidimensional dataset

In gdalraster: Bindings to 'GDAL'

Report structure and content of a multidimensional dataset

Description

mdim_info() is an interface to the gdalmdiminfo command-line utility (see https://gdal.org/en/stable/programs/gdalmdiminfo.html). This function lists various information about a GDAL supported multidimensional raster dataset as JSON output. It follows the JSON schema gdalmdiminfo_output.schema.json. Requires GDAL >= 3.2.

Usage

mdim_info(
  dsn,
  array_name = "",
  pretty = TRUE,
  detailed = FALSE,
  limit = -1L,
  stats = FALSE,
  array_options = NULL,
  allowed_drivers = NULL,
  open_options = NULL,
  cout = TRUE
)

Arguments

dsn	Character string giving the data source name of the multidimensional raster (e.g., file, VSI path).
array_name	Character string giving the name of the MDarray in dsn.
pretty	Logical value, FALSE to output a single line without any indentation. Defaults to TRUE.
detailed	Logical value, TRUE for verbose output. Report attribute data types and array values. Defaults to FALSE.
limit	Integer value. Number of values in each dimension that is used to limit the display of array values. By default, unlimited. Only taken into account if used with detailed = TRUE. Set to a positive integer to enable.
stats	Logical value, TRUE to read and display array statistics. Forces computation if no statistics are stored in an array. Defaults to FALSE.
array_options	Optional character vector of "NAME=VALUE" pairs to filter reported arrays. Such option is format specific. Consult driver documentation (passed to GDALGroup::GetMDArrayNames()).
allowed_drivers	Optional character vector of driver short names that must be considered when opening dsn. It is generally not necessary to specify it, but it can be used to skip automatic driver detection, when it fails to select the appropriate driver.
open_options	Optional character vector of format-specific dataset openoptions as "NAME=VALUE" pairs.
cout	Logical value, TRUE to print info to the console (the default), or FALSE to suppress console output.

Value

Invisibly, a JSON string containing information about the multidimensional raster dataset. By default, the info string is also printed to the console unless cout is set to FALSE.

See Also

mdim_as_classic(), mdim_translate()

Examples

f <- system.file("extdata/byte.nc", package="gdalraster")
mdim_info(f)

gdalraster documentation built on Nov. 19, 2025, 9:07 a.m.