unitname | R Documentation |
Inspect or change the name of the unit of length in a spatial dataset.
## S3 method for class 'dppm' unitname(x) ## S3 method for class 'kppm' unitname(x) ## S3 method for class 'minconfit' unitname(x) ## S3 method for class 'ppm' unitname(x) ## S3 method for class 'slrm' unitname(x) ## S3 replacement method for class 'dppm' unitname(x) <- value ## S3 replacement method for class 'kppm' unitname(x) <- value ## S3 replacement method for class 'minconfit' unitname(x) <- value ## S3 replacement method for class 'ppm' unitname(x) <- value ## S3 replacement method for class 'slrm' unitname(x) <- value
x |
A spatial dataset.
Either a point pattern (object of class |
value |
Name of the unit of length. See Details. |
Spatial datasets in the spatstat package may include the name of the unit of length. This name is used when printing or plotting the dataset, and in some other applications.
unitname(x)
extracts this name,
and unitname(x) <- value
sets the name to value
.
A valid name is either
a single character string
a vector of two character strings giving the singular and plural forms of the unit name
a list of length 3, containing two character strings giving the singular and plural forms of the basic unit, and a number specifying the multiple of this unit.
Note that re-setting the name of the unit of length does not
affect the numerical values in x
. It changes only the string
containing the name of the unit of length. To rescale the numerical
values, use rescale
.
The return value of unitname
is an object of class "unitname"
containing the name of the unit of length in x
. There are
methods for print
, summary
, as.character
,
rescale
and compatible
.
.
rescale
,
owin
,
ppp
X <- runifrect(20) # if the unit of length is 1 metre: unitname(X) <- c("metre", "metres") # if the unit of length is 6 inches: unitname(X) <- list("inch", "inches", 6)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.