Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions R/gd.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title native geographical detector(GD) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Jin‐Feng Wang, Xin‐Hu Li, George Christakos, Yi‐Lan Liao, Tin Zhang, XueGu & Xiao‐Ying Zheng (2010)
#' Geographical Detectors‐Based Health Risk Assessment and its Application in the Neural Tube Defects Study
Expand Down Expand Up @@ -45,7 +44,6 @@ gd = \(formula, data, type = "factor", alpha = 0.95){
}

#' @title print GD result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for GD model from `gd()`.
#'
Expand All @@ -65,7 +63,6 @@ print.gd_result = \(x, ...) {
}

#' @title plot GD result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for GD model result in `gd()`.
#'
Expand Down
1 change: 0 additions & 1 deletion R/gd_optunidisc.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title optimal univariate discretization based on geodetector q-statistic
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#'
#' @param formula A formula.
#' @param data A `data.frame`, `tibble` or `sf` object of observation data.
Expand Down
13 changes: 0 additions & 13 deletions R/geodetector.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title factor detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' The factor detector q-statistic measures the spatial stratified heterogeneity of a
#' variable Y, or the determinant power of a covariate X of Y.
Expand Down Expand Up @@ -59,7 +58,6 @@ factor_detector = \(y,x,confintv = FALSE,alpha = 0.95){
}

#' @title interaction detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Identify the interaction between different risk factors, that is, assess whether factors X1 and X2 together
#' increase or decrease the explanatory power of the dependent variable Y, or whether the effects of these factors
Expand Down Expand Up @@ -116,7 +114,6 @@ interaction_detector = \(y,x1,x2){
}

#' @title risk detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Determine whether there is a significant difference between the attribute means of two sub regions.
#'
Expand Down Expand Up @@ -165,7 +162,6 @@ risk_detector = \(y,x,alpha = 0.95){
}

#' @title ecological detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Compare the effects of two factors \eqn{X_1} and \eqn{X_2} on the spatial distribution of the attribute \eqn{Y}.
#'
Expand Down Expand Up @@ -201,7 +197,6 @@ ecological_detector = \(y,x1,x2,alpha = 0.95){
}

#' @title geographical detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @note
#' Note that only one type of geodetector is supported at a time in `geodetector()`.
#'
Expand Down Expand Up @@ -309,7 +304,6 @@ geodetector = \(formula,data,type = "factor",alpha = 0.95){
}

#' @title print factor detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for factor detector in `geodetector()`.
#'
Expand All @@ -326,7 +320,6 @@ print.factor_detector = \(x, ...) {
}

#' @title print interaction detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for interaction detector in `geodetector()`.
#'
Expand All @@ -349,7 +342,6 @@ print.interaction_detector = \(x, ...) {
}

#' @title print risk detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for risk detector in `geodetector()`.
#'
Expand Down Expand Up @@ -383,7 +375,6 @@ print.risk_detector = \(x, ...) {
}

#' @title print ecological detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for ecological detector in `geodetector()`.
#'
Expand Down Expand Up @@ -412,7 +403,6 @@ print.ecological_detector = \(x, ...) {
}

#' @title plot factor detector result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for factor detector in `geodetector()`.
#'
Expand Down Expand Up @@ -468,7 +458,6 @@ plot.factor_detector = \(x, slicenum = 2, alpha = 0.95,
}

#' @title plot interaction detector result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for interaction detector in `geodetector()`.
#'
Expand Down Expand Up @@ -515,7 +504,6 @@ plot.interaction_detector = \(x,alpha = 1,...){
}

#' @title plot risk detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for risk detector in `geodetector()`.
#'
Expand Down Expand Up @@ -560,7 +548,6 @@ plot.risk_detector = \(x, ...) {
}

#' @title plot ecological detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for ecological detector in `geodetector()`.
#'
Expand Down
4 changes: 0 additions & 4 deletions R/gozh.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title geographically optimal zones-based heterogeneity(GOZH) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Luo, P., Song, Y., Huang, X., Ma, H., Liu, J., Yao, Y., & Meng, L. (2022). Identifying determinants of
#' spatio-temporal disparities in soil moisture of the Northern Hemisphere using a geographically optimal
Expand Down Expand Up @@ -48,7 +47,6 @@ gozh = \(formula, data, cores = 1,
}

#' @title print GOZH result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for GOZH model from `gozh()`.
#'
Expand All @@ -70,7 +68,6 @@ print.gozh_result = \(x, ...) {
}

#' @title plot GOZH result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for GOZH model result in `gozh()`.
#'
Expand Down Expand Up @@ -101,7 +98,6 @@ plot.gozh_result = \(x, ...) {


#' @title geographically optimal zones-based heterogeneity detector
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for geographically optimal zones-based heterogeneity detector.
#' @references
Expand Down
3 changes: 0 additions & 3 deletions R/idsa.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title interactive detector for spatial associations(IDSA) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Yongze Song & Peng Wu (2021) An interactive detector for spatial associations,
#' International Journal of Geographical Information Science, 35:8, 1676-1701,
Expand Down Expand Up @@ -138,7 +137,6 @@ idsa = \(formula,data,wt = NULL,discnum = 3:8,discmethod = "quantile",
}

#' @title print IDSA result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for IDSA model from `idsa()`.
#'
Expand All @@ -163,7 +161,6 @@ print.idsa_result = \(x, ...) {
}

#' @title plot IDSA risk result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for IDSA risk result in `idsa()`.
#'
Expand Down
3 changes: 0 additions & 3 deletions R/lesh.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title locally explained stratified heterogeneity(LESH) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#'
#' @note
#' The LESH model requires at least \eqn{2^n-1} calculations when has \eqn{n} explanatory variables.
Expand Down Expand Up @@ -50,7 +49,6 @@ lesh = \(formula,data,cores = 1,...){
}

#' @title print LESH model interaction result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for LESH model interaction result in `lesh()`.
#'
Expand All @@ -72,7 +70,6 @@ print.lesh_result = \(x, ...) {
}

#' @title plot LESH model result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for LESH model interaction result in `lesh()`.
#' @note
Expand Down
1 change: 0 additions & 1 deletion R/loess_optscale.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#' @description
#' Function for determining optimal spatial data analysis scale based on locally
#' estimated scatter plot smoothing (LOESS) model.
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#'
#' @param qvec A numeric vector of q statistics.
#' @param spscalevec A numeric vector of spatial scales corresponding to `qvec`.
Expand Down
3 changes: 0 additions & 3 deletions R/opgd.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title optimal parameters-based geographical detector(OPGD) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @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
Expand Down Expand Up @@ -78,7 +77,6 @@ opgd = \(formula, data, discvar = NULL, discnum = 3:8,
}

#' @title print OPGD result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for OPGD model from `opgd()`.
#'
Expand All @@ -101,7 +99,6 @@ print.opgd_result = \(x, ...) {
}

#' @title plot OPGD result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for OPGD model result in `opgd()`.
#'
Expand Down
2 changes: 0 additions & 2 deletions R/pid_idsa.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title optimal spatial data discretization based on SPADE q-statistics
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for determining the optimal spatial data discretization based on SPADE q-statistics.
#' @references
Expand Down Expand Up @@ -134,7 +133,6 @@ cpsd_disc = \(formula, data, wt, discnum = 3:8, discmethod = "quantile", strate
}

#' PSD of an interaction of explanatory variables (PSD-IEV)
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Yongze Song & Peng Wu (2021) An interactive detector for spatial associations,
#' International Journal of Geographical Information Science, 35:8, 1676-1701,
Expand Down
2 changes: 0 additions & 2 deletions R/psd_pseudop.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title calculate power of spatial determinant(PSD) and the corresponding pseudo-p value
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for calculate power of spatial determinant \eqn{q_s}.
#' @details
Expand Down Expand Up @@ -66,7 +65,6 @@ psd_pseudop = \(y,x,wt,cores = 1,seed = 123456789,permutations = 0){
}

#' @title power of spatial and multilevel discretization determinant(PSMD) and the corresponding pseudo-p value
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for calculate power of spatial and multilevel discretization determinant and the corresponding pseudo-p value.
#' @details
Expand Down
4 changes: 0 additions & 4 deletions R/psd_spade.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title power of spatial determinant(PSD)
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for calculate power of spatial determinant `q_s`
#' @details
Expand Down Expand Up @@ -46,7 +45,6 @@ psd_spade = \(y,x,wt){
}

#' @title compensated power of spatial determinant(CPSD)
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for calculate compensated power of spatial determinant `Q_s`.
#' @details
Expand Down Expand Up @@ -79,7 +77,6 @@ cpsd_spade = \(yobs,xobs,xdisc,wt){
}

#' @title power of spatial and multilevel discretization determinant(PSMD)
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for calculate power of spatial and multilevel discretization determinant `PSMDQ_s`.
#' @details
Expand Down Expand Up @@ -168,7 +165,6 @@ psmd_spade = \(yobs, xobs, wt, discnum = 3:8,
}

#' @title measure information loss by information entropy
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Function for measure information loss by shannon information entropy.
#' @details
Expand Down
3 changes: 0 additions & 3 deletions R/rgd.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title robust geographical detector(RGD) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Zhang, Z., Song, Y.*, & Wu, P., 2022. Robust geographical detector. International Journal of Applied Earth Observation and Geoinformation. 109, 102782.
#' DOI: 10.1016/j.jag.2022.102782.
Expand Down Expand Up @@ -107,7 +106,6 @@ rgd = \(formula, data, discvar = NULL, discnum = 3:8, minsize = 1,
}

#' @title print RGD result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for RGD model from `rgd()`.
#'
Expand All @@ -123,7 +121,6 @@ print.rgd_result = \(x, ...) {
}

#' @title plot RGD result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for RGD model result in `rgd()`.
#'
Expand Down
3 changes: 0 additions & 3 deletions R/rid.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title robust interaction detector(RID) model
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Zhang, Z., Song, Y., Karunaratne, L., & Wu, P. (2024). Robust interaction detector:
#' A case of road life expectancy analysis. Spatial Statistics, 59(100814), 100814.
Expand Down Expand Up @@ -51,7 +50,6 @@ rid = \(formula, data, discvar = NULL, discnum = 3:8, minsize = 1,
}

#' @title print RID result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for RID model from `rid()`.
#'
Expand All @@ -68,7 +66,6 @@ print.rid_result = \(x, ...) {
}

#' @title plot RID result
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for RID model from `rid()`.
#'
Expand Down
1 change: 0 additions & 1 deletion R/robustdisc.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title univariate discretization based on offline change point detection
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' Determines discretization interval breaks using an optimization algorithm for variance-based
#' change point detection.
Expand Down
1 change: 0 additions & 1 deletion R/rpartdisc.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title discretization of variables based on recursive partitioning
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @references
#' Luo, P., Song, Y., Huang, X., Ma, H., Liu, J., Yao, Y., & Meng, L. (2022). Identifying determinants of
#' spatio-temporal disparities in soil moisture of the Northern Hemisphere using a geographically optimal
Expand Down
3 changes: 0 additions & 3 deletions R/sesu_gozh.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title comparison of size effects of spatial units based on GOZH
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @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
Expand Down Expand Up @@ -107,7 +106,6 @@ sesu_gozh = \(formula,datalist,su,cores = 1,strategy = 2L,
}

#' @title print gozh sesu
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for gozh sesu from `sesu_gozh()`.
#'
Expand All @@ -130,7 +128,6 @@ print.sesu_gozh = \(x,...){
}

#' @title plot gozh sesu
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for gozh sesu in `sesu_gozh()`.
#'
Expand Down
3 changes: 0 additions & 3 deletions R/sesu_opgd.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#' @title comparison of size effects of spatial units based on OPGD
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @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
Expand Down Expand Up @@ -77,7 +76,6 @@ sesu_opgd = \(formula,datalist,su,discvar,discnum = 3:8,
}

#' @title print opgd sesu
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to format output for opgd sesu from `sesu_opgd()`.
#'
Expand All @@ -100,7 +98,6 @@ print.sesu_opgd = \(x,...){
}

#' @title plot opgd sesu
#' @author Wenbo Lv \email{lyu.geosocial@gmail.com}
#' @description
#' S3 method to plot output for opgd sesu in `sesu_opgd()`.
#'
Expand Down
Loading