improves docs (fixes #41)

DESCRIPTION

@@ -23,7 +23,7 @@ Imports:
     philentropy (>= 0.6.0),
     future.apply
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 LinkingTo: 
     cpp11
 URL: https://jakubnowosad.com/supercells/

NEWS.md

@@ -1,6 +1,7 @@
 # supercells 1.0.3
 
 * C++ code improvements (Avoid implicit conversion from sexp to double, see #39)
+* Improves documentation of the `fun_avg` argument (see #41)
 
 # supercells 1.0.2
 

R/supercells.R

@@ -9,8 +9,7 @@
 #' @param compactness A compactness value. Larger values cause clusters to be more compact/even (square).
 #' A compactness value depends on the range of input cell values and selected distance measure.
 #' @param dist_fun A distance function. Currently implemented distance functions are `"euclidean"`, `"jsd"`, `"dtw"` (dynamic time warping), name of any distance function from the `philentropy` package (see [philentropy::getDistMethods()]; "log2" is used in this case), or any user defined function accepting two vectors and returning one value. Default: `"euclidean"`
-#' @param avg_fun An averaging function - how the values of the supercells' centers are calculated?
-#' It accepts any fitting R function (e.g., `base::mean()` or `stats::median()`) or one of internally implemented `"mean"` and `"median"`. Default: `"mean"`
+#' @param avg_fun An averaging function - how the values of the supercells' centers are calculated? The algorithm internally implements common functions `"mean"` and `"median"` (provided with quotation marks), but also accepts any fitting R function (e.g., `base::mean()` or `stats::median()`, provided as plain function name: `mean`). Default: `"mean"`.
 #' @param clean Should connectivity of the supercells be enforced?
 #' @param iter The number of iterations performed to create the output.
 #' @param minarea Specifies the minimal size of a supercell (in cells). Only works when `clean = TRUE`.