View source: R/hypervolume_segment.R

hypervolume_segment | R Documentation |

Performs hierarchical clustering (using the 'single' method described in `fastcluster::hclust`

) on the input hypervolume to determine which sets of points are closest to others, then cuts the resulting tree at a height equal to the characteristic distance between points multiplied by a distance factor. Random points in the input hypervolume corresponding to each distinct cluster are assigned to distinct output hypervolumes.

Because clustering algorithms scale quadratically with the number of input points, this algorithm can run slowly. Therefore by default, the function can thin the input hypervolume to a reduced number of random points before analysis. This causes some loss of resolution but improves runtimes.

```
hypervolume_segment(hv, distance.factor = 1, num.points.max = NULL,
verbose = TRUE, check.memory = TRUE)
```

`hv` |
An input |

`distance.factor` |
A numeric value characterizing the distance multiplication factor. Larger values result in fewer distinct output hypervolumes; smaller values result in more. |

`num.points.max` |
A numeric value describing the maximum number of random points to be retained in the input; passed to |

`verbose` |
Logical value; print diagnostic output if |

`check.memory` |
Logical value; returns information about expected memory usage if true. |

A `HypervolumeList`

object.

`hypervolume_thin`

```
# low sample sizes to meet CRAN time requirements
data(penguins,package='palmerpenguins')
penguins_no_na = as.data.frame(na.omit(penguins))
penguins_adelie = penguins_no_na[penguins_no_na$species=="Adelie",
c("bill_length_mm","bill_depth_mm","flipper_length_mm")]
# intentionally make a holey shape for segmentation example
hv = hypervolume_gaussian(penguins_adelie,name='Adelie',
kde.bandwidth=estimate_bandwidth(penguins_adelie)/3)
hv_segmented <- hypervolume_segment(hv,
num.points.max=200, distance.factor=1.25,
check.memory=FALSE) # intentionally under-segment
plot(hv_segmented,show.contour=FALSE)
```

hypervolume documentation built on May 31, 2023, 8:45 p.m.

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.