Filenames: Return the filename(s) from a Raster* object
In reproducible: Enhance Reproducibility of R Code

Filenames

R Documentation

Return the filename(s) from a `⁠Raster*⁠` object

Description

This is mostly just a wrapper around filename from the raster package, except that instead of returning an empty string for a RasterStack object, it will return a vector of length >1 for RasterStack.

Usage

Filenames(obj, allowMultiple = TRUE, returnList = FALSE)

## S4 method for signature 'ANY'
Filenames(obj, allowMultiple = TRUE, returnList = FALSE)

## S4 method for signature 'environment'
Filenames(obj, allowMultiple = TRUE, returnList = FALSE)

## S4 method for signature 'list'
Filenames(obj, allowMultiple = TRUE, returnList = FALSE)

## S4 method for signature 'data.table'
Filenames(obj, allowMultiple = TRUE, returnList = FALSE)

## S4 method for signature 'Path'
Filenames(obj, allowMultiple = TRUE, returnList = FALSE)

Arguments

`obj`	A `⁠Raster*⁠` object (i.e., `RasterLayer`, `RasterStack`, `RasterBrick`)
`allowMultiple`	Logical. If `TRUE`, the default, then all relevant filenames will be returned, i.e., in cases such as `.grd` where multiple files are required. If `FALSE`, then only the first file will be returned, e.g., `filename.grd`, in the case of default Raster format in R.
`returnList`	Default `FALSE`. If `FALSE`, then return format will be a character vector. When `TRUE`, list or environment objects will return a list of character strings or vectors. When returned as a character vector, then the names of objects with >1 filename associated with them will be given a numeric suffix, which means the name in the returned vector does not match the object in the list or environment. When returned as a list, their names are preserved.

Details

New methods can be made for this generic.

Value

A character vector of filenames that are part of the objects passed to obj. This returns NULL is the object is not file-backed or does not have a method to recover the file-backed filename.