is.prevR {prevR} | R Documentation |
Test if an object is of class prevR.
This function test if the class of an object is prevR.
It could be used to test the slot rings
or the slot boundary
.
Description
Test if an object is of class prevR.
This function test if the class of an object is prevR.
It could be used to test the slot rings
or the slot boundary
.
Usage
is.prevR(object, slot = NULL)
Arguments
object |
object to test. |
slot |
"clusters", "rings","boundary" or "proj". |
Details
Slots rings
and boundary
are always present in an object of
class prevR, but rings
could be NULL
and
boundary
a sf::sf object with an attribute named valid
with the value FALSE
(when boundaries of the studied
area have not been specified explicitly).
If
rings
isNULL
,is.prevR(object,"rings")
will returnFALSE
.If
boundary
has an attributevalid
equal toFALSE
,is.prevR(object,"boundary")
will returnFALSE
.
Value
TRUE
or FALSE
See Also
Examples
col <- c(
id = "cluster",
x = "x",
y = "y",
n = "n",
pos = "pos",
c.type = "residence",
wn = "weighted.n",
wpos = "weighted.pos"
)
dhs <- as.prevR(fdhs.clusters, col, fdhs.boundary)
is.prevR(dhs)
is.prevR(dhs, "rings")
is.prevR(dhs, "boundary")
dhs <- rings(dhs, N = 300)
is.prevR(dhs, "rings")
[Package prevR version 5.0.0 Index]