R: describe

describe {terra} | R Documentation

## describe

### Description

Describe the properties of spatial data in a file as generated with the "GDALinfo" tool.

### Usage

    ## S4 method for signature 'character'
    describe(x, sds=FALSE, meta=FALSE, parse=FALSE, options="", print=FALSE, open_opt="")

    desc(x)

### Arguments

`x` | character. The name of a file with spatial data. Or a fully specified subdataset within a file such as `"NETCDF:\"AVHRR.nc\":NDVI"`
`sds` | logical. If `TRUE` the description or metadata of the subdatasets is returned (if available)
`meta` | logical. Get the file level metadata instead
`parse` | logical. If `TRUE`, metadata for subdatasets is parsed into components (if `meta=TRUE`)
`options` | character. A vector of valid options (if `meta=FALSE`) including "json", "mm", "stats", "hist", "nogcp", "nomd", "norat", "noct", "nofl", "checksum", "proj4", "listmdd", "mdd <value>" where <value> specifies a domain or 'all', "wkt_format <value>" where value is one of 'WKT1', 'WKT2', 'WKT2_2015', or 'WKT2_2018', "sd <subdataset>" where <subdataset> is the name or identifier of a sub-dataset. See https://gdal.org/programs/gdalinfo.html. Ignored if `sds=TRUE`
`print` | logical. If `TRUE`, print the results
`open_opt` | character. Driver specific open options

### Value

character (invisibly, if `print=FALSE`)

### Examples

    f <- system.file("ex/elev.tif", package="terra")
    describe(f)
    describe(f, meta=TRUE)
    #g <- desc(f, options=c("json", "nomd", "proj4"))
    #cat(g, "\n")

[Package terra version 1.2-10 Index]