lxy.lhs: Create a LoCoH-hullset object from a LoCoH-xy object

Description Usage Arguments Details Value See Also

Description

Creates a LoCoH-hullset object (class "locoh.lhs") containing one or more sets of hulls.

Usage

1
2
3
4
5
6
lxy.lhs(lxy, id = NULL, s = 0, a = NULL, r = NULL, k = NULL,
  kmin = 0, anv.copy = TRUE, decimal.places = 1, offset.dups = 1,
  velocity.metrics = TRUE, ud = NULL, iso.add = FALSE,
  iso.levels = c(0.1, 0.25, 0.5, 0.75, 0.95), sliver_check = TRUE,
  pbo.style = 3, beep = FALSE, status = TRUE, save.hulls = TRUE,
  save.enc.pts = TRUE)

Arguments

lxy

A LoCoH-xy object

id

The id value(s) of lxy for which hullsets will be created. If NULL all ids will be used.

s

Value(s) for the s term in the time-scaled-distance equation for point-to-point distance. When s=0 time is excluded and TSD is equivalent to Euclidean distance. Numeric vector or comma-separated string. Can also be 'all'

a

Value(s) for the adaptive method. Numeric vector or comma-separated string. a also be the results of the auto.a function, see notes.

r

Value(s) for the r method. Numeric vector or comma separate list of values.

k

Value(s) for the k method. Numeric vector or comma separate list of values.

kmin

A minimum number of nearest neighbors for each parent point regardless of the method used. Set k=2 to ensure that every point is part of a hull. Integer.

anv.copy

Copy the ancillary variables data frame (if exists), T/F

decimal.places

The number of decimal places for the k/r/a parameter value used when constructing the name of a hullset. Note this has no effect on hull creation or the precision of values used, only the number of digits that appear in the hullset name.

offset.dups

A number of map units to randomly offset duplicate points. Set offset.dups=0 to ignore duplicate points

velocity.metrics

Compute the velocity hull metrics

ud

Deprecated (no longer used). Use iso.add instead

iso.add

Whether to also create density isopleths, T/F

iso.levels

Isopleth levels (see also lhs.iso.add), numeric vector. Ignored if |codeiso.add=FALSE.

sliver_check

Whether to check for and delete slivers in isopleths. See details. T/F

pbo.style

Progress bar style (see pbapply package)

beep

Beep when done. T/F

status

Show messages. T/F

save.hulls

Whether to save the hulls. T/F

save.enc.pts

Whether to save the enclosed points. T/F

Details

This function creates a LoCoH-hullset object from a LoCoH-xy object. Other functions allow you to do things with hullsets, including computing additional hull metrics, constructing isopleths, directional routes, generating scatterplots, exporting, etc. Note that before you use this function, nearest neighbors must have already been identified and saved in the input LoCoH-xy object (see lxy.nn.add).

If iso.add=TRUE, after the hulls are created the function will create density isopleths using the default sort order (area for k-method, number of enclosed points for the a and r-methods). You can control which isopleth levels are created using the iso.levels argument. If sliver_check=TRUE, isopleths will checked for 'slivers'. Slivers (as used here) refer to polygons or holes with <3 unique nodes. Slivers can be caused by reductions in numeric precision or rounding errors, and are not uncommon.

When working with a large dataset where memory limts may affect performance, you can choose to not save the hulls or enclosed points by setting save.hulls=FALSE and save.enc.pts=FALSE. See the vignette on working with large datasets.

Value

An object of class locoh.lhs

See Also

xyt.lxy for creating LoCoH-xy objects lhs.iso.add for adding isopleths lhs.ellipses.add for computing bounding ellipses lhs.visit.add for computing time-use metrics lhs.plot.scatter for creating scatterplots of hull metrics plot.locoh.lhs for plotting a LoCoH-hullset hulls for extracting hulls as a SpatialPolygonsDataFrame lhs.exp.shp to export hulls as shapefile


tlocoh documentation built on May 2, 2019, 5:27 p.m.