Fix return type for get_medoids_final() and expose get_labels()

motiwari · Sep 16, 2023 · 056651f · 056651f
1 parent 0560f35
commit 056651f
Show file tree

Hide file tree

Showing 24 changed files with 126 additions and 31 deletions.
diff --git a/R_package/banditpam/DESCRIPTION b/R_package/banditpam/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: banditpam
 Title: Almost Linear-Time k-Medoids Clustering
-Version: 1.0-1
+Version: 1.0-2
 Authors@R: c(person("Balasubramanian", "Narasimhan", role=c("aut", "cre"),
 	   	   email = "[email protected]"),
 	     person("Mo", "Tiwari", role=c("aut"),

diff --git a/R_package/banditpam/NEWS.md b/R_package/banditpam/NEWS.md
@@ -1,3 +1,8 @@
+# banditpam 1.0-2
+
+* Fixed up return type for `get_medoids_final()` method for medoid object
+* Exposed `get_labels()` method for medoid object
+
 # banditpam 1.0-1
 
 * Typographical fixes

diff --git a/R_package/banditpam/R/KMedoid.R b/R_package/banditpam/R/KMedoid.R
@@ -122,6 +122,14 @@ KMedoids <- R6::R6Class( "KMedoids"
     }
    ,
 
+    #' @description
+    #' Return the cluster labels after clustering
+    #' @return a vector of the cluster labels for the observations
+    get_labels = function() {
+      .Call('_banditpam_KMedoids__get_labels', PACKAGE = 'banditpam', private$xptr)
+    }
+   ,
+
     #' @description
     #' Get the specified statistic after clustering
     #' @param what a string which should one of `"dist_computations"`, `"dist_computations_and_misc"`,

diff --git a/R_package/banditpam/R/RcppExports.R b/R_package/banditpam/R/RcppExports.R
@@ -19,6 +19,10 @@ bpam_num_threads <- function() {
     .Call('_banditpam_KMedoids__get_medoids_final', PACKAGE = 'banditpam', xp)
 }
 
+.KMedoids__get_labels <- function(xp) {
+    .Call('_banditpam_KMedoids__get_labels', PACKAGE = 'banditpam', xp)
+}
+
 .KMedoids__get_k <- function(xp) {
     .Call('_banditpam_KMedoids__get_k', PACKAGE = 'banditpam', xp)
 }

diff --git a/R_package/banditpam/README.md b/R_package/banditpam/README.md
@@ -21,7 +21,7 @@ Here's a BibTeX entry:
 
 ## Installation
 
-`banditpam` can be installed from CRAN like any other package.
+`banditpam` can be installed from CRAN like any other package. 
 
 ## Example
 
@@ -43,6 +43,8 @@ meds <- obj$get_medoids_final()
 ## Plot the results
 plot(X[, 1], X[, 2])
 points(X[meds, 1], X[meds, 2], col = "red", pch = 19)
+## Retrieve cluster labels
+clusters <- obj$get_labels()
 ##
 ## One can query some statistics too; see help("KMedoids")
 ##

diff --git a/R_package/banditpam/docs/404.html b/R_package/banditpam/docs/404.html
diff --git a/R_package/banditpam/docs/LICENSE-text.html b/R_package/banditpam/docs/LICENSE-text.html
diff --git a/R_package/banditpam/docs/articles/index.html b/R_package/banditpam/docs/articles/index.html
diff --git a/R_package/banditpam/docs/articles/kmediods.html b/R_package/banditpam/docs/articles/kmediods.html
diff --git a/R_package/banditpam/docs/articles/kmediods_files/figure-html/unnamed-chunk-9-1.png b/R_package/banditpam/docs/articles/kmediods_files/figure-html/unnamed-chunk-9-1.png
diff --git a/R_package/banditpam/docs/authors.html b/R_package/banditpam/docs/authors.html
diff --git a/R_package/banditpam/docs/deps/bootstrap-5.2.2/bootstrap.min.css b/R_package/banditpam/docs/deps/bootstrap-5.2.2/bootstrap.min.css
diff --git a/R_package/banditpam/docs/index.html b/R_package/banditpam/docs/index.html
diff --git a/R_package/banditpam/docs/news/index.html b/R_package/banditpam/docs/news/index.html
diff --git a/R_package/banditpam/docs/pkgdown.yml b/R_package/banditpam/docs/pkgdown.yml
@@ -1,7 +1,7 @@
-pandoc: 3.1.1
+pandoc: 3.1.7
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles:
   kmediods: kmediods.html
-last_built: 2023-03-14T18:31Z
+last_built: 2023-09-16T00:52Z
 
diff --git a/R_package/banditpam/docs/reference/BanditPAM-package.html b/R_package/banditpam/docs/reference/BanditPAM-package.html
diff --git a/R_package/banditpam/docs/reference/KMedoids.html b/R_package/banditpam/docs/reference/KMedoids.html
diff --git a/R_package/banditpam/docs/reference/bpam_num_threads.html b/R_package/banditpam/docs/reference/bpam_num_threads.html
diff --git a/R_package/banditpam/docs/reference/index.html b/R_package/banditpam/docs/reference/index.html