Grid
From smint v0.4.2
by Yann Richet
Create a new Grid object
Create a Grid object.
Usage
Grid(levels, nlevels = NULL, dimNames = NULL, index = NULL)Arguments
- levels
- A list with the levels of the variables. The length of the list gives the spatial dimension. The $i$-th element must be a numeric vector containing the distinct values of the corresponding variable.
- nlevels
- Integer vector giving the number of levels by
dimension. This formal argument is used only when
levelsis missing. In this case, the nodes for dimension $i$ will be regularly spaced between0.0and1.0. - dimNames
- If the list
levelsdoes not have names, then the character vectordimNameswill be used. - index
- An array with integer values and dimension corresponding to the spatial dimensions. Each value represent the number of the corresponding node in a "flat" representation (data.frame or matrix), and will be used in tasks such as interpolation.
Value
-
An object with S4 class
"Grid". If needed, this
object can be coerced to a data frame or to a matrix by using the
methods as.data.frame or as.matrix.
Note
If index is not provided, the vectors in the
levels list can be unsorted, and they will be
sorted. However, when a non-default index is provided, the
levels must be sorted. This rule is intended to reduce the risk of
error.
Examples
myGD1 <- Grid(levels = list("X" = c(0, 1), "Y" = c(0.0, 0.5, 1.0)))
## the same with less effort
myGD2 <- Grid(nlevels = c("X" = 2, "Y" = 3))
nlevels(myGD2)
levels(myGD2)
Community examples
Looks like there are no examples yet.