lhs.filter.hsp: Define subsets of hulls based on the location of the parent...

Description Usage Arguments Details Value

Description

Define subsets of hulls based on the location of the parent point in hull scatterplot space

Usage

1
2
3
lhs.filter.hsp(lhs, id = NULL, k = NULL, r = NULL, a = NULL,
  s = NULL, hs.names = NULL, hsp = NULL, reg.idx = NULL,
  label = NULL, col = NULL)

Arguments

lhs

A LoCoH-hullset object

id

The name(s) of the individual(s) to include in the plot. Character vector or comma-delimited character.

k

The k value of hullsets to create isopleths for

r

The r value of hullsets to create isopleths for

a

The a value of hullsets to create isopleths for

s

The s value of hullsets to create isopleths for

hs.names

The name(s) of saved hullsets to create isopleths for

hsp

Either the index of a hull scatterplot(s) saved in lhs (use summary.locoh.lhs to which how many hsp objects have been saved), or a list of objects of class locoh.hsp (i.e., the return value of lhs.plot.scatter.

reg.idx

A numeric vector of the indices of the regions in hsp to include in the filter

label

Character vector of the labels to use for each subset. If not passed, the saved label values in hsp will be used

col

Vector of color values (one per region). If omitted the colors saved in hsp will be used

Details

This will return a list that defines subsets of hulls grouped according to which manually-digitized region in scatterplot space the hull parent point falls. This can be passed to several functions, including plot.locoh.lhs (future), and lhs.plot.scatter, to create plots of subsets of hulls.

The scatterplot space, including the manually defined regions, are saved in a locoh.hsp object. Typically hsp will be created using the lhs.plot.scatter function. hsp objects can also be saved in the lhs object (see lhs.hsp.add.

Note that this function can only return subsets for *one* hullset and *one* hsp object. This means that either lhs must contain a single hullset, or other parameters (e.g., id, hs.names, k, r, and/or a) are passed to select one and only one of the hullsets in lhs.

Value

A list that defines subsets of hulls, with one element for each region in hsp. Each element is a list with three elements:

idx

indices of the hull parent points

label

the label of the region of hsp

col

the color of the region in hsp


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