deleteDataset {gdalraster} | R Documentation |
Delete named dataset
Description
deleteDataset()
will attempt to delete the named dataset in a format
specific fashion. Full featured drivers will delete all associated files,
database objects, or whatever is appropriate. The default behavior when no
format specific behavior is provided is to attempt to delete all the files
that would be returned by GDALRaster$getFileList()
on the dataset.
The named dataset should not be open in any existing GDALRaster
objects
when deleteDataset()
is called. Wrapper for GDALDeleteDataset()
in the
GDAL API.
Usage
deleteDataset(filename, format = "")
Arguments
filename |
Filename to delete (should not be open in a |
format |
Raster format short name (e.g., "GTiff"). If set to empty
string |
Value
Logical TRUE
if no error or FALSE
on failure.
Note
If format
is set to an empty string ""
(the default) then the function
will try to identify the driver from filename
. This is done internally in
GDAL by invoking the Identify
method of each registered GDALDriver
in
turn. The first driver that successful identifies the file name will be
returned. An error is raised if a format cannot be determined from the
passed file name.
See Also
GDALRaster-class
, create()
, createCopy()
,
copyDatasetFiles()
, renameDataset()
Examples
b5_file <- system.file("extdata/sr_b5_20200829.tif", package="gdalraster")
b5_tmp <- file.path(tempdir(), "b5_tmp.tif")
file.copy(b5_file, b5_tmp)
ds <- new(GDALRaster, b5_tmp)
ds$buildOverviews("BILINEAR", levels = c(2, 4, 8), bands = c(1))
files <- ds$getFileList()
print(files)
ds$close()
file.exists(files)
deleteDataset(b5_tmp)
file.exists(files)