segmentation-class: segmentation class description

In rpatin/segclust2d: Bivariate Segmentation/Clustering Methods and Tools

segmentation class description

Description

segmentation class description

print.segmentation prints object of segmentation class

plot.segmentation plot object of segmentation class - wrapper for plot_segm

likelihood.segmentation deprecated function for plotting likelihood estimates of segmentation object. Now use plot_likelihood.

plot_likelihood plot likelihood estimates of a segmentation object - works only for picard segmentation.

get_likelihood returns likelihood estimates of a segmentation object. Deprecated, now use logLik.segmentation.

logLik.segmentation returns log-likelihood estimates of a segmentation object

plot_BIC plot BIC estimates of a segmentation object - works only for segclust algorithm.

BIC returns BIC-based penalized log-likelihood estimates of a segmentation object when segmentation/clustering has been run.

stateplot plot state distribution of a segmentation object

states return data.frame with states statistics a segmentation object

segment return data.frame with segment information of a segmentation object

augment.segmentation return data.frame with original data and state information of a segmentation object

segmap create maps with object of segmentation class (interpreting latitude/longitude)

Usage

## S3 method for class 'segmentation'
print(x, max.level = 1, ...)

## S3 method for class 'segmentation'
plot(x, nseg, ncluster, interactive = FALSE, xcol = "indice", order, ...)

## S3 method for class 'segmentation'
likelihood(x, ...)

plot_likelihood(x)

get_likelihood(x)

## S3 method for class 'segmentation'
logLik(object, ...)

plot_BIC(x)

## S3 method for class 'segmentation'
BIC(object, ...)

stateplot(x, nseg, ncluster, order)

states(x, nseg, ncluster)

segment(x, nseg, ncluster)

## S3 method for class 'segmentation'
augment(x, nseg, ncluster, colname_state = "state", ...)

segmap(
  x,
  interactive = FALSE,
  nseg,
  ncluster,
  html = FALSE,
  scale = 1,
  width = 400,
  height = 400,
  order,
  pointsize = 1,
  linesize = 0.5,
  ...
)

Arguments

x	a segmentation object generated by segmentation
max.level	argument to be passed to utils::str()
...	additional arguments
nseg	number of segment chosen
ncluster	number of classes chosen
interactive	whether plot are interactive (dygraphs/leaflet) or not (ggplot2)
xcol	column for x axis. can be POSIXct
order	should cluster be ordered
object	a segmentation-class object, created by segclust.
colname_state	column name for the added state column
html	whether htmltools::tagList should be applied on the returned object object for integrating in html pages
scale	for dividing coordinates to have compatibility with leaflet
width	width
height	height
pointsize	size of points
linesize	size of lines

Examples

## Not run: 
plot(res.segclust)
plot(res.segclust, nseg = 10, ncluster = 3)

## End(Not run)

## Not run: 
plot_likelihood(res.seg)

## End(Not run)

## Not run: 
logLik(res.seg)

## End(Not run)

## Not run: 
plot_BIC(res.segclust)

## End(Not run)

## Not run: 
plot_BIC(res.segclust)

## End(Not run)

## Not run: 
stateplot(res.segclust)
stateplot(res.seg)

## End(Not run)
## Not run: 
states(res.segclust)
states(res.seg)

## End(Not run)

## Not run: 
segment(res.segclust)
segment(res.segclust, ncluster = 3, nseg = 30)
segment(res.seg)
segment(res.seg, nseg = 4)

## End(Not run)
## Not run: 
augment(res.segclust)
augment(res.segclust, ncluster = 3, nseg = 30)
augment(res.seg)
augment(res.seg, nseg = 4)

## End(Not run)
## Not run: 
segmap(res.segclust, coord.names = c("x", "y"))
segmap(res.segclust, ncluster = 3, nseg = 30)
segmap(res.seg)
segmap(res.seg, nseg = 4)

## End(Not run)

rpatin/segclust2d documentation built on Sept. 10, 2022, 8:02 a.m.