Skip to content

Commit

Permalink
Update NEWS and example
Browse files Browse the repository at this point in the history
  • Loading branch information
jlmelville committed Apr 14, 2024
1 parent f03e920 commit 1eebf59
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ in the documentation, and also the rnndescent package's
[documentation](https://jlmelville.github.io/rnndescent/index.html) for details.
`rnndescent` is only a suggested package, not a requirement, so you need to
install it yourself (e.g. via `install.packages("rnndescent")`).
* New function: `umap2`, which acts like `umap` but with modified defaults,
reflecting my experience with UMAP and correcting some small mistakes. See the
[umap2 article](https://jlmelville.github.io/uwot/articles/umap2.html) for more
details.

## Bug fixes and minor improvements

Expand Down
3 changes: 0 additions & 3 deletions R/umap2.R
Original file line number Diff line number Diff line change
Expand Up @@ -593,9 +593,6 @@
#' @examples
#'
#' iris30 <- iris[c(1:10, 51:60, 101:110), ]
#'
#' # Non-numeric columns are automatically removed so you can pass data frames
#' # directly in a lot of cases without pre-processing
#' iris_umap <- umap2(iris30, n_neighbors = 5)
#'
#' @references
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ devtools::install_github("jlmelville/uwot")
```R
library(uwot)

# umap2 is a version of the umap() function with better defaults
iris_umap <- umap2(iris)

# but you can still use the umap function (which most of the existing
# documentation does)
iris_umap <- umap(iris)

# Load mnist from somewhere, e.g.
Expand Down
5 changes: 1 addition & 4 deletions man/umap2.Rd

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

0 comments on commit 1eebf59

Please sign in to comment.