Skip to content

Commit

Permalink
release: 0.1.10 (#94)
Browse files Browse the repository at this point in the history
* chore: readme

* release: 0.1.10

* chore: remotes

* docs: task link
  • Loading branch information
be-marc authored Oct 7, 2024
1 parent fc5f974 commit 4238c78
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 19 deletions.
6 changes: 2 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: mlr3cluster
Title: Cluster Extension for 'mlr3'
Version: 0.1.9.9000
Version: 0.1.10
Authors@R: c(
person("Damir", "Pulatov", , "[email protected]", role = c("cre", "aut")),
person("Michel", "Lang", , "[email protected]", role = "aut",
Expand All @@ -14,7 +14,7 @@ URL: https://mlr3cluster.mlr-org.com,
https://github.com/mlr-org/mlr3cluster
BugReports: https://github.com/mlr-org/mlr3cluster/issues
Depends:
mlr3 (>= 0.14.0),
mlr3 (>= 0.21.0),
R (>= 3.1.0)
Imports:
backports (>= 1.1.10),
Expand All @@ -39,8 +39,6 @@ Suggests:
RWeka,
stream,
testthat (>= 3.0.0)
Remotes:
mlr-org/mlr3
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE, r6 = TRUE)
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# mlr3cluster (development version)
# mlr3cluster 0.1.10

* Add BIRCH learner from 'stream' package
* Add BICO learner from 'stream' package
Expand Down
1 change: 1 addition & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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) |
Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## revdepcheck results

We checked 2 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
We checked 3 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

* We saw 0 new problems
* We failed to check 0 packages
2 changes: 1 addition & 1 deletion man-roxygen/task.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#' @section Dictionary:
#' This [mlr3::Task] can be instantiated via the [dictionary][mlr3misc::Dictionary] [mlr3::mlr_tasks] or with the associated sugar function [tsk()]:
#' This [mlr3::Task] can be instantiated via the [dictionary][mlr3misc::Dictionary] [mlr3::mlr_tasks] or with the associated sugar function [mlr3::tsk()]:
#' ```
#' mlr_tasks$get("<%= id %>")
#' tsk("<%= id %>")
Expand Down
2 changes: 1 addition & 1 deletion man/mlr_tasks_ruspini.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/mlr_tasks_usarrests.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4238c78

Please sign in to comment.