write stars object to gdal dataset (typically: to file)

write_stars(obj, dsn, layer, ...)

# S3 method for stars
write_stars(
  obj,
  dsn,
  layer = 1,
  ...,
  driver = detect.driver(dsn),
  options = character(0),
  type = "Float32",
  NA_value = NA_real_,
  update = FALSE
)

# S3 method for stars_proxy
write_stars(
  obj,
  dsn,
  layer = 1,
  ...,
  driver = detect.driver(dsn),
  options = character(0),
  type = "Float32",
  NA_value = NA_real_,
  chunk_size = c(dim(obj)[1], floor(2.5e+07/dim(obj)[1])),
  progress = TRUE
)

Arguments

obj

object of class stars

dsn

gdal dataset (file) name

layer

attribute name; if missing, the first attribute is written

...

passed on to gdal_write

driver

driver driver name; see st_drivers

options

character vector with options

type

character; output binary type, one of: Byte for eight bit unsigned integer, UInt16 for sixteen bit unsigned integer, Int16 for sixteen bit signed integer, UInt32 for thirty two bit unsigned integer, Int32 for thirty two bit signed integer, Float32 for thirty two bit floating point, Float64 for sixty four bit floating point.

NA_value

non-NA value that should represent R's NA value in the target raster file; if set to NA, it will be ignored.

update

logical; if TRUE, an existing file is being updated

chunk_size

length two integer vector with the number of pixels (x, y) used in the read/write loop; see details.

progress

logical; if TRUE, a progress bar is shown

Details

write_stars first creates the target file, then updates it sequentially by writing blocks of chunk_size.