From 38fd57d55ed667395f865a3f6406b92474fd506a Mon Sep 17 00:00:00 2001
From: SpatLyu <lyu.geosocial@gmail.com>
Date: Tue, 18 Jun 2024 13:53:53 +0800
Subject: [PATCH] specification RGD function help documentation

---
 R/rgd.R            | 2 +-
 R/robustdisc.R     | 2 +-
 man/rgd.Rd         | 2 +-
 man/robust_disc.Rd | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/R/rgd.R b/R/rgd.R
index 1051a8f3..8830402b 100644
--- 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
index dd91d8c3..add66de5 100644
--- 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
index 7fefdb67..9e6c99e7 100644
--- a/man/rgd.Rd
+++ b/man/rgd.Rd
@@ -29,7 +29,7 @@ Default all \code{discvar} use \code{10}.}
 
 \item{minsize}{(optional) The min size of each discretization group.Default all use \code{1}.}
 
-\item{cores}{positive integer(default is 1). If cores > 1, use \code{python}'s \code{joblib} package to
+\item{cores}{(optional) Positive integer(default is 1). If cores > 1, use \code{python}'s \code{joblib} package to
 parallel computation.}
 
 \item{type}{(optional) The type of geographical detector,which must be \code{factor}(default),
diff --git a/man/robust_disc.Rd b/man/robust_disc.Rd
index f20a3b6c..2c20d382 100644
--- a/man/robust_disc.Rd
+++ b/man/robust_disc.Rd
@@ -15,7 +15,7 @@ robust_disc(formula, data, discnum, minsize = NULL, cores = 1)
 
 \item{minsize}{(optional) The min size of each discretization group.Default all use \code{1}.}
 
-\item{cores}{positive integer(default is 1). If cores > 1, use \code{python}'s \code{joblib} package to
+\item{cores}{(optional) Positive integer(default is 1). If cores > 1, use \code{python}'s \code{joblib} package to
 parallel computation.}
 }
 \value{