diff --git a/README.Rmd b/README.Rmd
index e8b4af5..4c33662 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -67,13 +67,16 @@ plot(st_geometry(vol_slic1), add = TRUE, lwd = 0.5, border = "red")
## Documentation
-Version 2 (in development) focuses on a clearer workflow, better diagnostics, and more guidance on choosing parameters and interpreting results.
+Version 2 (in development) focuses on a clearer workflow, tools for diagnostics, and more guidance on choosing parameters and interpreting results.
Start with these vignettes:
+1. [Introduction to supercells](https://jakubnowosad.com/supercells/articles/v2-intro.html)
+2. [Choosing parameters for supercells](https://jakubnowosad.com/supercells/articles/v2-parameters.html)
+3. [Evaluation and diagnostics](https://jakubnowosad.com/supercells/articles/v2-evaluation.html)
+
+If you are already familiar with version 1.0.0, you can jump to the summary of changes:
+
1. [Main changes since version 1.0.0](https://jakubnowosad.com/supercells/articles/v2-changes-since-v1.html)
-2. [Introduction to supercells](https://jakubnowosad.com/supercells/articles/v2-intro.html)
-3. [Choosing parameters for supercells](https://jakubnowosad.com/supercells/articles/v2-parameters.html)
-4. [Evaluation and diagnostics](https://jakubnowosad.com/supercells/articles/v2-evaluation.html)
Watch the presentations about this package and some related ideas:
diff --git a/README.md b/README.md
index fd988c1..c4abdc5 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
status](https://www.r-pkg.org/badges/version/supercells)](https://CRAN.R-project.org/package=supercells)
[](https://github.com/Nowosad/supercells/actions)
[](https://app.codecov.io/gh/Nowosad/supercells?branch=master)
+coverage](https://codecov.io/gh/Nowosad/supercells/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Nowosad/supercells?branch=main)
[](https://cran.r-project.org/package=supercells)
@@ -20,7 +20,7 @@ meaningful, coherent regions. This package works on spatial data with
one variable (e.g., continuous raster), many variables (e.g., RGB
rasters), and spatial patterns (e.g., areas in categorical rasters). It
is based on the SLIC algorithm (Achanta et al. (2012)), adapted to work
-with arbitrary dissimilarity measures.
+with arbitrary dissimilarity measures and multidimensional data.
## Installation
@@ -31,16 +31,18 @@ You can install the released version of supercells from
install.packages("supercells")
```
-You can install the development version from
-[GitHub](https://github.com/) with:
+You can install the development version with:
``` r
install.packages("supercells", repos = "https://nowosad.r-universe.dev")
```
+
+
+
## Example
@@ -48,38 +50,44 @@ install.packages("supercells", repos = "https://nowosad.r-universe.dev")
``` r
library(supercells)
library(terra)
-#> terra 1.6.49
library(sf)
-#> Linking to GEOS 3.11.0, GDAL 3.5.2, PROJ 9.0.1; sf_use_s2() is TRUE
vol = rast(system.file("raster/volcano.tif", package = "supercells"))
plot(vol)
```
-
+
+
+Here, `step` controls the approximate spacing between supercell centers,
+and `compactness` allows to balance spatial proximity versus value
+similarity.
``` r
-vol_slic1 = sc_slic(vol, step = 8, compactness = 1)
+vol_slic1 = sc_slic(vol, step = 8, compactness = 7)
plot(vol)
plot(st_geometry(vol_slic1), add = TRUE, lwd = 0.5, border = "red")
```
-
+
## Documentation
-The upcoming version 2 (development) introduces a refreshed API with
-`sc_`-prefixed functions (for example, `sc_slic()`), plus new tooling for
-parameter tuning and evaluation. Start with these v2 vignettes:
+Version 2 (in development) focuses on a clearer workflow, tools for
+diagnostics, and more guidance on choosing parameters and interpreting
+results. Start with these vignettes:
-1. [Main changes since version
- 1.0.0](https://jakubnowosad.com/supercells/articles/v2-changes-since-v1.html)
-2. [Introduction to
+1. [Introduction to
supercells](https://jakubnowosad.com/supercells/articles/v2-intro.html)
-3. [Choosing parameters for
+2. [Choosing parameters for
supercells](https://jakubnowosad.com/supercells/articles/v2-parameters.html)
-4. [Evaluation and
+3. [Evaluation and
diagnostics](https://jakubnowosad.com/supercells/articles/v2-evaluation.html)
+If you are already familiar with version 1.0.0, you can jump to the
+summary of changes:
+
+1. [Main changes since version
+ 1.0.0](https://jakubnowosad.com/supercells/articles/v2-changes-since-v1.html)
+
Watch the presentations about this package and some related ideas:
1. *Spatial segmentation in R using the supercells package*,
@@ -100,7 +108,7 @@ Read the related article:
## Contribution
-Contributions to this package are welcome - let us know if you need
+Contributions to this package are welcome – let us know if you need
other distance measures or transformations, have any suggestions, or
spotted a bug. The preferred method of contribution is through a GitHub
pull request. Feel also free to contact us by creating [an
diff --git a/man/figures/README-unnamed-chunk-2-1.png b/man/figures/README-unnamed-chunk-2-1.png
index bab115c..e0010f9 100644
Binary files a/man/figures/README-unnamed-chunk-2-1.png and b/man/figures/README-unnamed-chunk-2-1.png differ
diff --git a/man/figures/README-unnamed-chunk-3-1.png b/man/figures/README-unnamed-chunk-3-1.png
index 4b2c7b4..d68e5e2 100644
Binary files a/man/figures/README-unnamed-chunk-3-1.png and b/man/figures/README-unnamed-chunk-3-1.png differ