chore: readme

README.Rmd

@@ -16,6 +16,7 @@ library(mlr3cluster)
 library(mlr3misc)
 lrn_clust = as.data.table(mlr3::mlr_learners)[task_type == "clust", .(key, label, packages)]
 msr_clust = as.data.table(mlr3::mlr_measures)[task_type == "clust", .(key, label, packages)]
+lrn_clust = lrn_clust[key != c("clust.bico", "clust.birch")] # remove after cran release
 ```
 
 # mlr3cluster

README.md

@@ -41,10 +41,10 @@ pak::pak("mlr-org/mlr3cluster")
 
 The current version of **mlr3cluster** contains:
 
-- A selection of 24 clustering learners that represent a wide variety of
-  clusterers: partitional, hierarchical, fuzzy, etc.
-- A selection of 4 performance measures
-- Two built-in tasks to get started with clustering
+-   A selection of 22 clustering learners that represent a wide variety
+    of clusterers: partitional, hierarchical, fuzzy, etc.
+-   A selection of 4 performance measures
+-   Two built-in tasks to get started with clustering
 
 Also, the package is integrated with
 **[mlr3viz](https://github.com/mlr-org/mlr3viz)** which enables you to
@@ -60,8 +60,6 @@ create great visualizations with just one line of code!
 | [clust.SimpleKMeans](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.SimpleKMeans) | K-Means (Weka)                        | [RWeka](https://cran.r-project.org/package=RWeka)         |
 | [clust.agnes](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.agnes)               | Agglomerative Hierarchical Clustering | [cluster](https://cran.r-project.org/package=cluster)     |
 | [clust.ap](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.ap)                     | Affinity Propagation Clustering       | [apcluster](https://cran.r-project.org/package=apcluster) |
-| [clust.bico](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.bico)                 | BICO Clustering                       | [stream](https://cran.r-project.org/package=stream)       |
-| [clust.birch](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.birch)               | BIRCH Clustering                      | [stream](https://cran.r-project.org/package=stream)       |
 | [clust.cmeans](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.cmeans)             | Fuzzy C-Means Clustering Learner      | [e1071](https://cran.r-project.org/package=e1071)         |
 | [clust.cobweb](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.cobweb)             | Cobweb Clustering                     | [RWeka](https://cran.r-project.org/package=RWeka)         |
 | [clust.dbscan](https://mlr3cluster.mlr-org.com/reference/mlr_learners_clust.dbscan)             | Density-Based Clustering              | [dbscan](https://cran.r-project.org/package=dbscan)       |
@@ -112,10 +110,10 @@ has a section on clustering.
 
 ## Future Plans
 
-- Add more learners and measures
-- Integrate the package with
-  **[mlr3pipelines](https://github.com/mlr-org/mlr3pipelines)** (work in
-  progress)
+-   Add more learners and measures
+-   Integrate the package with
+    **[mlr3pipelines](https://github.com/mlr-org/mlr3pipelines)** (work
+    in progress)
 
 If you have any questions, feedback or ideas, feel free to open an issue
 [here](https://github.com/mlr-org/mlr3cluster/issues).