specification RGD function help documentation

stscl · Jun 18, 2024 · 38fd57d · 38fd57d
1 parent 360358e
commit 38fd57d
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/R/rgd.R b/R/rgd.R
@@ -13,7 +13,7 @@
 #' @param discnum A numeric vector of discretized classes of columns that need to be discretized.
 #' Default all `discvar` use `10`.
 #' @param minsize (optional) The min size of each discretization group.Default all use `1`.
-#' @param cores positive integer(default is 1). If cores > 1, use `python`'s `joblib` package to
+#' @param cores (optional) Positive integer(default is 1). If cores > 1, use `python`'s `joblib` package to
 #' parallel computation.
 #' @param type (optional) The type of geographical detector,which must be `factor`(default),
 #' `interaction`, `risk`, `ecological`.You can run one or more at a time.

diff --git a/R/robustdisc.R b/R/robustdisc.R
@@ -8,7 +8,7 @@
 #' @param data A data.frame or tibble of observation data.
 #' @param discnum A numeric vector of discretized classes of columns that need to be discretized.
 #' @param minsize (optional) The min size of each discretization group.Default all use `1`.
-#' @param cores positive integer(default is 1). If cores > 1, use `python`'s `joblib` package to
+#' @param cores (optional) Positive integer(default is 1). If cores > 1, use `python`'s `joblib` package to
 #' parallel computation.
 #'
 #' @return A tibble of discretized classes of columns that need to be discretized.

diff --git a/man/rgd.Rd b/man/rgd.Rd
diff --git a/man/robust_disc.Rd b/man/robust_disc.Rd