st_as_stars | R Documentation |
convert objects into a stars object
st_as_stars(.x, ...)
## S3 method for class 'list'
st_as_stars(.x, ..., dimensions = NULL)
## Default S3 method:
st_as_stars(.x = NULL, ..., raster = NULL)
## S3 method for class 'stars'
st_as_stars(.x, ..., curvilinear = NULL, crs = st_crs("OGC:CRS84"))
## S3 method for class 'bbox'
st_as_stars(
.x,
...,
nx,
ny,
dx = dy,
dy = dx,
xlim = .x[c("xmin", "xmax")],
ylim = .x[c("ymin", "ymax")],
values = 0,
n = 64800,
pretty = FALSE,
inside = FALSE,
nz,
proxy = FALSE
)
## S3 method for class 'sf'
st_as_stars(.x, ..., name = attr(.x, "sf_column"))
## S3 method for class 'Raster'
st_as_stars(.x, ..., att = 1, ignore_file = FALSE)
## S3 method for class 'SpatRaster'
st_as_stars(
.x,
...,
ignore_file = FALSE,
as_attributes = all(terra::is.factor(.x))
)
## S3 method for class 'ncdfgeom'
st_as_stars(.x, ..., sf_geometry = NA)
## S3 method for class 'stars_proxy'
st_as_stars(
.x,
...,
downsample = 0,
url = attr(.x, "url"),
envir = parent.frame()
)
## S3 method for class 'data.frame'
st_as_stars(
.x,
...,
dims = coords,
xy = dims[1:2],
y_decreasing = TRUE,
coords = 1:2
)
## S3 method for class 'xts'
st_as_stars(.x, ..., dimensions, name = "attr")
## S3 method for class 'OpenStreetMap'
st_as_stars(.x, ..., as_col = FALSE)
## S3 method for class 'cubble_df'
st_as_stars(.x, ..., check_times = FALSE)
.x |
object to convert |
... |
in case |
dimensions |
object of class dimensions |
raster |
character; the names of the dimensions that denote raster dimensions |
curvilinear |
only for creating curvilinear grids: named length 2 list holding longitude and latitude matrices or stars arrays, or the names of the corresponding attributes in |
crs |
object of class |
nx |
integer; number of cells in x direction; see details |
ny |
integer; number of cells in y direction; see details |
dx |
numeric or object of class units; cell size in x direction; see details |
dy |
numeric or object of class units; cell size in y direction; see details |
xlim |
length 2 numeric vector with extent (min, max) in x direction |
ylim |
length 2 numeric vector with extent (min, max) in y direction |
values |
value(s) to populate the raster values with |
n |
the (approximate) target number of grid cells |
pretty |
logical; should cell coordinates have pretty values? |
inside |
logical; should all cells entirely fall inside the bbox, potentially not covering it completely ( |
nz |
integer; number of cells in z direction; if missing no z-dimension is created. |
proxy |
logical; should a |
name |
character; attribute name for array from an |
att |
see factorValues; column in the RasterLayer's attribute table |
ignore_file |
logical; if |
as_attributes |
logical; if |
sf_geometry |
sf data.frame with geometry and attributes to be added to stars object. Must have same number of rows as timeseries instances. |
downsample |
integer: if larger than 0, downsample with this rate (number of pixels to skip in every row/column); if length 2, specifies downsampling rate in x and y. |
url |
character; URL of the stars endpoint where the data reside |
envir |
environment to resolve objects in |
dims |
the column names or indices that form the cube dimensions |
xy |
the x and y raster dimension names or indices; only takes effect after dims has been specified |
y_decreasing |
logical; if TRUE, (numeric) y values get a negative delta (decrease with increasing index) |
coords |
same as dims, for symmetry with st_as_sf |
as_col |
logical; return rgb numbers (FALSE) or (character) color values (TRUE)? |
check_times |
logical; should we check that the time stamps of all time series are identical? |
if curvilinear
is a list with stars
objects with longitude and latitude values, its coordinate reference system is typically not that of the latitude and longitude values. If curvilinear
contains the names of two arrays in .x
, then these are removed from the returned object.
For the bbox
method: if pretty
is TRUE
, raster cells may extend the coordinate range of .x
on all sides. If in addition to nx
and ny
, dx
and dy
are also missing, these are set to a single value computed as sqrt(diff(xlim)*diff(ylim)/n)
.
If nx
and ny
are missing and values
is a matrix, the number of columns and rows of the matrix are taken.
Otherwise, if nx
and ny
are missing, they are computed as the (ceiling, floor, or rounded to integer value) of the ratio of the (x or y) range divided by (dx or dy), depending on the value of inside
. Positive dy
will be made negative. Further named arguments (...
) are passed on to pretty
. If dx
or dy
are units
objects, their value is converted to the units of st_crs(.x)
(only when sf >= 1.0-7).
For the ncdfgeom
method: objects are point-timeseries with optional line or polygon geometry for each timeseries specified with the sf_geometry
parameter. See ncdfgeom for more about this NetCDF-based format for geometry and timeseries.
for the xts
methods, if dimensions
are provided, time has to be the first dimension.
if (require(plm, quietly = TRUE)) {
data(Produc, package = "plm")
st_as_stars(Produc, y_decreasing = FALSE)
data(Produc, package = "plm")
st_as_stars(Produc, y_decreasing = FALSE)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.