lhs.so.add: Add hull metrics for association analysis

Description Usage Arguments Details Value

View source: R/lhs.so.add.R

Description

Add hull metrics for association analysis

Usage

1
2
3
lhs.so.add(lhs, id = "all", hs2.id = "all", tbuff = 0, ivg = NULL,
  test = 0, skip.dups = TRUE, save.hso = TRUE, status = TRUE,
  piFUN = c("pIntersect", "pIntersectSat")[1])

Arguments

lhs

A LoCoH-hullset object

id

A character vector of the hullset ids to compute metrics for. Can also be 'all'.

hs2.id

A character vector of the hullset ids to use as the comparison hullsets. Can also be 'all'.

tbuff

A temporal overlap threshhold (in seconds). See details.

ivg

The intervisit gap period used to collapse intersecting hulls into discrete visits, see details

test

A two-element numeric vector containing the number of hulls in hullset 1 and hullset 2 respectively to identify intersections

skip.dups

Skip duplicate hulls (faster)

save.hso

Whether to save the hull intersection list, T/F

status

Show status messages. T/F

piFUN

The function to use to identify which pairs of hulls intersect: 'pIntersect' or 'pIntersectSat'

Details

This function computes hull metrics for the spatially overlapping hulls from two ids. Typically this would be used when you have hullset from two individuals (i.e., two animals) and you want to see the spatial and temporal patterns of shared space use.

You can impose a temporal overlap requirement as well by passing a value for tbuff. Two hulls will be considered spatially overlapping only if their parent points also were recorded within tbuff seconds of each other. This essentially produces metrics for spatially and temporally overlapping hulls.

Hullset metrics are computed for each pair of ids. Thus if a hullset has hulls for three unique ids, each hull will have spatial overlap metrics computed for each of the other two hullsets. You can narrow which id(s) to compute metrics for, and which hullset(s) to use as the comparison, with the id and hs2.id arguments.

Up to three spatial overlap metrics are computed. so.count is simply the number of hulls in hullset 2 that overlap. so.dtmin is the minimum amount of time (expressed in seconds) that passes between overlapping hulls. This reflects temporal partitioning of shared space - low values of so.dtmin suggest the two individuals don't mind being in the same area at the same time. so.nsv (number of separate visits) is similiar to so.count, but collapses overlapping hulls into discrete visits based on an intervisit gap period ivg. so.nsv is only computed if a value for ivg is passed.

pIntersect and pIntersectSat are two functions that identify which pairs of hulls actually intersect. Neither are terribly fast, but pIntersect appears to work faster than pIntersectSat.

Value

A LoCoH-hullset object


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