https://github.com/clugen/clugenr
Multidimensional cluster generation in R
https://github.com/clugen/clugenr
multidimensional-clusters multidimensional-data r r-package synthetic-clusters synthetic-data-generator synthetic-dataset-generation
Last synced: 11 months ago
JSON representation
Multidimensional cluster generation in R
- Host: GitHub
- URL: https://github.com/clugen/clugenr
- Owner: clugen
- License: other
- Created: 2020-08-22T19:52:42.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T17:51:56.000Z (almost 2 years ago)
- Last Synced: 2025-06-19T03:05:31.098Z (12 months ago)
- Topics: multidimensional-clusters, multidimensional-data, r, r-package, synthetic-clusters, synthetic-data-generator, synthetic-dataset-generation
- Language: R
- Homepage: https://clugen.github.io/clugenr/
- Size: 37.7 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
[](https://github.com/clugen/clugenr/actions/workflows/check.yml)
[](https://app.codecov.io/gh/clugen/clugenr)
[](https://clugen.github.io/clugenr/)
[](https://CRAN.R-project.org/package=clugenr)
[](https://www.tldrlegal.com/license/mit-license)
# 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:
```R
install.packages("clugenr")
```
Alternatively, install the development version from GitHub with the following
command (requires the [devtools] package):
```R
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:
```R
help("clugenr")
```
The complete online documentation is available [here](https://clugen.github.io/clugenr/).
## Quick start
```R
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)
```
```R
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](https://github.com/clugen/pyclugen/), a Python implementation of
the *clugen* algorithm.
* [CluGen.jl](https://github.com/clugen/CluGen.jl/), an Julia implementation of
the *clugen* algorithm.
* [MOCluGen](https://github.com/clugen/MOCluGen/), a MATLAB/Octave implementation
of the *clugen* algorithm.
## Reference
If you use this software, please cite the following reference:
* Fachada, N. & de Andrade, D. (2023). Generating multidimensional clusters
with support lines. *Knowledge-Based Systems*, 277, 110836.
([arXiv preprint](https://doi.org/10.48550/arXiv.2301.10327))
## License
[MIT License](LICENSE)
[R]: https://www.r-project.org/
[devtools]: https://cran.r-project.org/package=devtools
[CRAN]: https://cran.r-project.org/