From 2350a6fb9915e5fb0c84b8d5f2e1e5f3c723c496 Mon Sep 17 00:00:00 2001 From: SpatLyu Date: Thu, 9 Jan 2025 11:13:34 +0800 Subject: [PATCH] fix #39 --- NAMESPACE | 2 +- R/{gd_bestunidisc.R => gd_optunidisc.R} | 20 +++++++++---------- R/opgd.R | 8 +++----- man/{gd_bestunidisc.Rd => gd_optunidisc.Rd} | 22 ++++++++++----------- man/opgd.Rd | 2 +- 5 files changed, 25 insertions(+), 29 deletions(-) rename R/{gd_bestunidisc.R => gd_optunidisc.R} (81%) rename man/{gd_bestunidisc.Rd => gd_optunidisc.Rd} (68%) diff --git a/NAMESPACE b/NAMESPACE index 133c3c7b..f26a1baf 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -44,7 +44,7 @@ export(cpsd_spade) export(ecological_detector) export(factor_detector) export(gd) -export(gd_bestunidisc) +export(gd_optunidisc) export(gen_permutations) export(geodetector) export(gozh) diff --git a/R/gd_bestunidisc.R b/R/gd_optunidisc.R similarity index 81% rename from R/gd_bestunidisc.R rename to R/gd_optunidisc.R index e9c4d3d1..dcee8c6b 100644 --- a/R/gd_bestunidisc.R +++ b/R/gd_optunidisc.R @@ -1,11 +1,9 @@ -#' @title best univariate discretization based on geodetector q-statistic +#' @title optimal univariate discretization based on geodetector q-statistic #' @author Wenbo Lv \email{lyu.geosocial@gmail.com} -#' @description -#' Function for determining the best univariate discretization based on geodetector q-statistic. #' -#' @param formula A formula of best univariate discretization. +#' @param formula A formula. #' @param data A `data.frame`, `tibble` or `sf` object of observation data. -#' @param discnum (optional) A vector of number of classes for discretization. Default is `3:8`. +#' @param discnum (optional) A vector of numbers of discretization. Default is `3:8`. #' @param discmethod (optional) A vector of methods for discretization, default is using #' `c("sd","equal","geometric","quantile","natural")` by invoking `sdsfun`. #' @param cores (optional) Positive integer (default is 1). When cores are greater than 1, use @@ -25,13 +23,13 @@ #' #' @examples #' data('sim') -#' gd_bestunidisc(y ~ xa + xb + xc, -#' data = sim, -#' discnum = 3:6) +#' gd_optunidisc(y ~ xa + xb + xc, +#' data = sim, +#' discnum = 3:6) #' -gd_bestunidisc = \(formula, data, discnum = 3:8, - discmethod = c("sd","equal","geometric","quantile","natural"), - cores = 1, seed = 123456789, ...){ +gd_optunidisc = \(formula, data, discnum = 3:8, + discmethod = c("sd","equal","geometric","quantile","natural"), + cores = 1, seed = 123456789, ...){ doclust = FALSE if (cores > 1) { doclust = TRUE diff --git a/R/opgd.R b/R/opgd.R index 7aabf807..f4f81db6 100644 --- a/R/opgd.R +++ b/R/opgd.R @@ -1,7 +1,5 @@ #' @title optimal parameters-based geographical detector(OPGD) model #' @author Wenbo Lv \email{lyu.geosocial@gmail.com} -#' @description -#' Function for optimal parameters-based geographical detector(OPGD) model. #' @references #' Song, Y., Wang, J., Ge, Y. & Xu, C. (2020) An optimal parameters-based geographical detector #' model enhances geographic characteristics of explanatory variables for spatial heterogeneity @@ -55,9 +53,9 @@ opgd = \(formula, data, discvar = NULL, discnum = 3:8, discvar = colnames(data)[-which(colnames(data) == yname)] } discdf = dplyr::select(data,dplyr::all_of(c(yname,discvar))) - g = gd_bestunidisc(paste0(yname,'~',paste0(discvar,collapse = '+')), - data = discdf, discnum = discnum, - discmethod = discmethod, cores = cores, ...) + g = gd_optunidisc(paste0(yname,'~',paste0(discvar,collapse = '+')), + data = discdf, discnum = discnum, + discmethod = discmethod, cores = cores, ...) opt_param = tibble::as_tibble(g[1:3]) names(opt_param) = c("varibale","discnum","method") discedvar = colnames(data[,-which(colnames(data) %in% discvar)]) diff --git a/man/gd_bestunidisc.Rd b/man/gd_optunidisc.Rd similarity index 68% rename from man/gd_bestunidisc.Rd rename to man/gd_optunidisc.Rd index 61eb5cac..f4dd7cb4 100644 --- a/man/gd_bestunidisc.Rd +++ b/man/gd_optunidisc.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/gd_bestunidisc.R -\name{gd_bestunidisc} -\alias{gd_bestunidisc} -\title{best univariate discretization based on geodetector q-statistic} +% Please edit documentation in R/gd_optunidisc.R +\name{gd_optunidisc} +\alias{gd_optunidisc} +\title{optimal univariate discretization based on geodetector q-statistic} \usage{ -gd_bestunidisc( +gd_optunidisc( formula, data, discnum = 3:8, @@ -15,11 +15,11 @@ gd_bestunidisc( ) } \arguments{ -\item{formula}{A formula of best univariate discretization.} +\item{formula}{A formula.} \item{data}{A \code{data.frame}, \code{tibble} or \code{sf} object of observation data.} -\item{discnum}{(optional) A vector of number of classes for discretization. Default is \code{3:8}.} +\item{discnum}{(optional) A vector of numbers of discretization. Default is \code{3:8}.} \item{discmethod}{(optional) A vector of methods for discretization, default is using \code{c("sd","equal","geometric","quantile","natural")} by invoking \code{sdsfun}.} @@ -42,13 +42,13 @@ A list. } } \description{ -Function for determining the best univariate discretization based on geodetector q-statistic. +optimal univariate discretization based on geodetector q-statistic } \examples{ data('sim') -gd_bestunidisc(y ~ xa + xb + xc, - data = sim, - discnum = 3:6) +gd_optunidisc(y ~ xa + xb + xc, + data = sim, + discnum = 3:6) } \author{ diff --git a/man/opgd.Rd b/man/opgd.Rd index ab39fdbe..8857ba76 100644 --- a/man/opgd.Rd +++ b/man/opgd.Rd @@ -52,7 +52,7 @@ A list. } } \description{ -Function for optimal parameters-based geographical detector(OPGD) model. +optimal parameters-based geographical detector(OPGD) model } \examples{ data('sim')