add vignettes

.ellipses->ellipses
.convex.hulls->convex.hulls

Author: kleanthisk10

NAMESPACE

@@ -1,11 +1,11 @@
 # Generated by roxygen2: do not edit by hand
 
-export(.convex.hulls)
-export(.ellipses)
 export(cl.analysis)
 export(cl.features)
 export(cl.plot)
 export(cl.summary)
+export(convex.hulls)
+export(ellipses)
 export(nums)
 export(open_spending.cl)
 import(car)

R/cl.analysis.r

@@ -193,9 +193,9 @@ cl.analysis = function(cl.data, cl_feature = NULL, amount = NULL, cl.aggregate =
 
     # ellipses + convex hulls
 
-    cluster.ellipses = .ellipses(modelparam, data.pca)
+    cluster.ellipses = ellipses(modelparam, data.pca)
 
-    cluster.convex.hulls = .convex.hulls(modelparam, data.pca)
+    cluster.convex.hulls = convex.hulls(modelparam, data.pca)
 
     ## model parameters
 
@@ -234,9 +234,9 @@ cl.analysis = function(cl.data, cl_feature = NULL, amount = NULL, cl.aggregate =
 
     ### ellipses + convex hulls
 
-    cluster.ellipses = .ellipses( modelparam, data.pca )
+    cluster.ellipses = ellipses( modelparam, data.pca )
 
-    cluster.convex.hulls = .convex.hulls( modelparam, data.pca )
+    cluster.convex.hulls = convex.hulls( modelparam, data.pca )
 
     ## model parameters
 
@@ -273,9 +273,9 @@ cl.analysis = function(cl.data, cl_feature = NULL, amount = NULL, cl.aggregate =
     )
     ## ellipses + convex hulls
 
-    cluster.ellipses = .ellipses(modelparam, data.pca)
+    cluster.ellipses = ellipses(modelparam, data.pca)
 
-    cluster.convex.hulls = .convex.hulls(modelparam, data.pca)
+    cluster.convex.hulls = convex.hulls(modelparam, data.pca)
 
     ## model parameters
 
@@ -313,9 +313,9 @@ cl.analysis = function(cl.data, cl_feature = NULL, amount = NULL, cl.aggregate =
 
     ## ellipses + convex hulls
 
-    cluster.ellipses = .ellipses(modelparam, data.pca)
+    cluster.ellipses = ellipses(modelparam, data.pca)
 
-    cluster.convex.hulls = .convex.hulls(modelparam, data.pca)
+    cluster.convex.hulls = convex.hulls(modelparam, data.pca)
 
     ## model parameters
 

R/cl.plot.R

@@ -69,7 +69,7 @@ cl.plot <- function(clustering.model, parameters = list()) {
 #' @param data.pca data as result of the \code{stats::prcomp(clustering.model$data, scale. = T, center = T)}.
 #' @return List of vectors with points for each ellipse.
 #' @export
-.ellipses <- function(clustering.model, data.pca) {
+ellipses <- function(clustering.model, data.pca) {
   lapply(
     unique(clustering.model$clusters), 
     function(cl) {
@@ -94,7 +94,7 @@ cl.plot <- function(clustering.model, parameters = list()) {
 #' @param data.pca data as result of the \code{stats::prcomp(clustering.model$data, scale. = T, center = T)}.
 #' @return List of vectors with points for each convex hull.
 #' @export
-.convex.hulls <- function(clustering.model, data.pca) {
+convex.hulls <- function(clustering.model, data.pca) {
 
   lapply(
 

man/convex.hulls.Rd

@@ -2,7 +2,7 @@
 title: "Using Cluster.OBeu with OpenCPU"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Vignette Title}
+  %\VignetteIndexEntry{Using Cluster.OBeu with OpenCPU}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
@@ -100,3 +100,6 @@ For larger datasets you can specify likewise a specific clustering feature (*cl_
 # Github
 + [OpenCPU package *development version*](https://github.com/opencpu/opencpu)
 + [Cluster.OBeu package *development version*](https://github.com/okgreece/Cluster.OBeu)
+
+# CRAN
++ [Cluster.OBeu on CRAN](https://cran.r-project.org/package=Cluster.OBeu)

man/ellipses.Rd

@@ -191,6 +191,12 @@ <h1>Github</h1>
 <li><a href="https://github.com/okgreece/Cluster.OBeu">Cluster.OBeu package <em>development version</em></a></li>
 </ul>
 </div>
+<div id="cran" class="section level1">
+<h1>CRAN</h1>
+<ul>
+<li><a href="https://cran.r-project.org/package=Cluster.OBeu">Cluster.OBeu on CRAN</a></li>
+</ul>
+</div>
 
 
 

vignettes/Cluster.OBeuOpenCPU.Rmd

@@ -2,7 +2,7 @@
 title: "Cluster analysis in OpenBudget.eu"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Vignette Title}
+  %\VignetteIndexEntry{Cluster analysis in OpenBudget.eu}
   %\VignetteEngine{knitr::rmarkdown}
   %\VignetteEncoding{UTF-8}
 ---
@@ -150,3 +150,5 @@ You add likewise further parameters and change the default parameters of `cl.met
 + [OpenCPU package *development version*](https://github.com/opencpu/opencpu)
 + [Cluster.OBeu package *development version*](https://github.com/okgreece/Cluster.OBeu)
 
+# CRAN
++ [Cluster.OBeu on CRAN](https://cran.r-project.org/package=Cluster.OBeu)

vignettes/Cluster.OBeuOpenCPU.html

@@ -247,6 +247,12 @@ <h1>Github</h1>
 <li><a href="https://github.com/okgreece/Cluster.OBeu">Cluster.OBeu package <em>development version</em></a></li>
 </ul>
 </div>
+<div id="cran" class="section level1">
+<h1>CRAN</h1>
+<ul>
+<li><a href="https://cran.r-project.org/package=Cluster.OBeu">Cluster.OBeu on CRAN</a></li>
+</ul>
+</div>