Multidimensional Cluster Generation Using Support Lines

An implementation of the clugen algorithm for generating multidimensional clusters with arbitrary distributions. Each cluster is supported by a line segment, the position, orientation and length of which guide where the respective points are placed. This package is described in Fachada & de Andrade (2023) .


Checks codecov docs CRAN_Status_Badge Downloads MIT

clugenr

Summary

clugenr is an R implementation of the clugen algorithm for generating multidimensional clusters with arbitrary distributions. Each cluster is supported by a line segment, the position, orientation and length of which guide where the respective points are placed.

How to install

A stable version of the package is available on CRAN and can be installed with the following instruction:

install.packages("clugenr")

Alternatively, install the development version from GitHub with the following command (requires the devtools package):

devtools::install_github("clugen/clugenr")

Documentation

All methods and functions are fully documented and can be queried using the built-in help system. After installation, to access the man pages, invoke the clugenr help page as follows:

help("clugenr")

The complete online documentation is available here.

Quick start

library(clugenr)
x <- clugen(2, 5, 1000, c(1, -0.5), 0.5, c(4, 6), 6, 0.2, 0.5)
plot(x$points, col = x$clusters, xlab = "x", ylab = "y", asp = 1)

library(clugenr)
library(rgl) # For 3D plots
x <- clugen(3, 5, 2000, c(1, 0.5, -0.7), 0.5, c(15, 10, 20), 15, 3, 10)
plot3d(x$points, col = x$clusters, xlab = "x", ylab = "y", zlab = "z", aspect = T)

See also

  • pyclugen, a Python implementation of the clugen algorithm.
  • CluGen.jl, an Julia implementation of the clugen algorithm.
  • MOCluGen, a MATLAB/Octave implementation of the clugen algorithm.

Reference

If you use this software, please cite the following reference:

License

MIT License

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("clugenr")

1.0.4 by Nuno Fachada, a year ago


https://clugen.github.io/clugenr/, https://github.com/clugen/clugenr


Report a bug at https://github.com/clugen/clugenr/issues


Browse source code at https://github.com/cran/clugenr


Authors: Nuno Fachada [aut, cre, cph] (ORCID:


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports mathjaxr

Suggests crul, devtools, ggplot2, knitr, lintr, patchwork, prettydoc, rgl, rmarkdown, roxygen2, testthat


See at CRAN