diff --git a/404.html b/404.html index cdabf29b..13135af5 100644 --- a/404.html +++ b/404.html @@ -6,7 +6,7 @@ Page not found (404) • rgeoda - + @@ -18,7 +18,7 @@ - +
- +
@@ -97,16 +97,16 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/index.html b/articles/index.html index bd9f8858..9de02646 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,9 +1,9 @@ -Articles • rgeodaArticles • rgeoda - +
- +
@@ -69,15 +69,15 @@

All vignettes

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/articles/rgeoda_tutorial.html b/articles/rgeoda_tutorial.html index e233f39d..1afacc84 100644 --- a/articles/rgeoda_tutorial.html +++ b/articles/rgeoda_tutorial.html @@ -6,20 +6,19 @@ Tutorial of rgeoda • rgeoda - + - - +
- +
@@ -80,7 +79,7 @@

Xun Li

1/6/2021

- Source: vignettes/rgeoda_tutorial.Rmd + Source: vignettes/rgeoda_tutorial.Rmd
@@ -339,8 +338,8 @@

3.3 Distance Based Weightsmin_distthreshold to help you find a optimized distance threshold that guarantees that every observation has at least one neighbor:

-
min_distthreshold(GeoDa gda, bool is_arc = False, is_mile = True)
-To create a Distance based weights, one can call the function `distance_weights`:
+
min_distthreshold(GeoDa gda, bool is_arc = False, is_mile = True)
+To create a Distance based weights, one can call the function `distance_weights`:

Then, with this distance threshold, we can create a distance-band weights using the function:

@@ -531,7 +530,7 @@ 
4.1 Local Moranpvals
##  [1] 0.414 0.123 0.001 0.474 0.452 0.087 0.243 0.326 0.299 0.303 0.237 0.461
 ## [13] 0.248 0.015 0.178 0.166 0.124 0.003 0.456 0.346 0.053 0.145 0.431 0.425
-## [25] 0.005 0.037 0.464 0.395 0.138 0.316 0.495 0.431 0.359 0.129 0.295 0.058
+## [25] 0.005 0.037 0.465 0.395 0.138 0.316 0.495 0.431 0.359 0.129 0.295 0.058
 ## [37] 0.090 0.231 0.258 0.018 0.026 0.455 0.073 0.057 0.222 0.023 0.369 0.338
 ## [49] 0.282 0.359 0.483 0.252 0.450 0.434 0.138 0.327 0.063 0.005 0.097 0.292
 ## [61] 0.001 0.217 0.237 0.126 0.145 0.344 0.008 0.340 0.079 0.300 0.033 0.142
@@ -578,14 +577,14 @@ 
4.1 Local Moran
 pvals <- lisa_pvalues(lisa)
 pvals

-
##  [1] 0.4187 0.1265 0.0004 0.4679 0.4545 0.0728 0.2312 0.3071 0.3115 0.3088
-## [11] 0.2187 0.4834 0.2686 0.0102 0.2024 0.1789 0.1320 0.0020 0.4558 0.3519
-## [21] 0.0479 0.1376 0.4441 0.4195 0.0032 0.0388 0.4733 0.4187 0.1278 0.3300
+
##  [1] 0.4186 0.1265 0.0004 0.4679 0.4545 0.0728 0.2313 0.3071 0.3115 0.3087
+## [11] 0.2187 0.4834 0.2686 0.0102 0.2024 0.1790 0.1320 0.0020 0.4558 0.3519
+## [21] 0.0479 0.1376 0.4441 0.4195 0.0032 0.0388 0.4736 0.4188 0.1277 0.3300
 ## [31] 0.4939 0.4427 0.3393 0.1419 0.2714 0.0606 0.0724 0.2247 0.2628 0.0185
-## [41] 0.0214 0.4899 0.0719 0.0589 0.2288 0.0189 0.3759 0.3217 0.2812 0.3735
-## [51] 0.4695 0.2743 0.4518 0.4286 0.1471 0.3222 0.0647 0.0025 0.0917 0.2812
-## [61] 0.0001 0.2419 0.2462 0.1266 0.1270 0.3553 0.0094 0.3123 0.0724 0.2975
-## [71] 0.0307 0.1320 0.0001 0.0002 0.4633 0.0056 0.2162 0.3681 0.1335 0.4069
+## [41] 0.0214 0.4899 0.0719 0.0589 0.2288 0.0189 0.3759 0.3216 0.2812 0.3735
+## [51] 0.4695 0.2743 0.4518 0.4286 0.1471 0.3221 0.0647 0.0025 0.0917 0.2812
+## [61] 0.0001 0.2419 0.2462 0.1266 0.1270 0.3553 0.0094 0.3122 0.0724 0.2975
+## [71] 0.0307 0.1320 0.0001 0.0002 0.4633 0.0056 0.2162 0.3681 0.1334 0.4069
 ## [81] 0.4536 0.3547 0.0035 0.3096 0.1277

 
rgeoda uses GeoDa C++ code, in which
 multi-threading is used to accelerate the computation of LISA. We can
@@ -893,7 +892,7 @@ 
5.1 SKATER<
 prune to tree into several clusters that their values of selected
 variables are as similar as possible.

 
The rgeoda’s SKATER function is:

-
skater(k, w, data, distance_method='euclidean', bound_vals = [],  min_bound = 0, random_seed=123456789)

+
skater(k, w, data, distance_method='euclidean', bound_vals = [],  min_bound = 0, random_seed=123456789)

 
For example, to create 4 spatially contiguous clusters using Guerry
 dataset, the queen weights and the values of the 6 selected
 variables:

@@ -1320,9 +1319,7 @@ 
6.3 Create Local Moran Map
 
-        
-
+
@@ -1335,16 +1332,16 @@

6.3 Create Local Moran Map

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/authors.html b/authors.html index 85366c51..d874f323 100644 --- a/authors.html +++ b/authors.html @@ -1,9 +1,9 @@ -Authors and Citation • rgeodaAuthors and Citation • rgeoda - +
- +
-

Authors

+

Authors and Citation

- +
  • -

    Xun Li. Author, maintainer. +

    Xun Li. Author, maintainer.

  • -

    Luc Anselin. Author. +

    Luc Anselin. Author.

Citation

- Source: DESCRIPTION + Source: DESCRIPTION
-

Li X, Anselin L (2023). +

Li X, Anselin L (2024). rgeoda: R Library for Spatial Data Analysis. -https://github.com/geodacenter/rgeoda/, https://geodacenter.github.io/rgeoda/. +R package version 0.0.10-4, https://geodacenter.github.io/rgeoda/, https://github.com/geodacenter/rgeoda/. 

@Manual{,
   title = {rgeoda: R Library for Spatial Data Analysis},
   author = {Xun Li and Luc Anselin},
-  year = {2023},
-  note = {https://github.com/geodacenter/rgeoda/, https://geodacenter.github.io/rgeoda/},
+  year = {2024},
+  note = {R package version 0.0.10-4, https://geodacenter.github.io/rgeoda/},
+  url = {https://github.com/geodacenter/rgeoda/},
 }
@@ -94,15 +95,15 @@

Citation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/index.html b/index.html index 53bca1b8..d2f82765 100644 --- a/index.html +++ b/index.html @@ -6,23 +6,20 @@ R Library for Spatial Data Analysis • rgeoda - + - + - +
- +
@@ -104,6 +101,11 @@

Quick Startlisa <- local_moran(w, guerry['Crm_prs']) clusters <- skater(4, w, guerry[c('Crm_prs','Crm_prp','Litercy','Donatns','Infants','Suicids')])

+

Citation +

+

Anselin, L., Li, X. and Koschinsky, J. (2022), GeoDa, From the Desktop to an Ecosystem for Exploring Spatial Data. Geogr Anal, 54: 439-466. Download Citation

+
+

Tutorials

https://geodacenter.github.io/rgeoda/articles/rgeoda_tutorial.html

@@ -247,7 +249,7 @@

Links

License

    -
  • GPL (>= 2)
    • +
  • GPL (>= 2)
@@ -280,16 +282,16 @@

Developers

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/pkgdown.yml b/pkgdown.yml index 4f3baf4a..0984cb93 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,7 +1,6 @@ -pandoc: 2.19.2 -pkgdown: 2.0.7 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: rgeoda_tutorial: rgeoda_tutorial.html -last_built: 2023-07-03T17:51Z - +last_built: 2024-07-22T23:14Z diff --git a/reference/LISA-class.html b/reference/LISA-class.html index ac8daed5..5778dc46 100644 --- a/reference/LISA-class.html +++ b/reference/LISA-class.html @@ -1,9 +1,9 @@ -LISA class (Internally Used) — LISA-class • rgeodaLISA class (Internally Used) — LISA-class • rgeoda - +
- +

LISA class (Internally Used)

- Source: R/lisa.R + Source: R/lisa.R
@@ -62,7 +62,7 @@

LISA class (Internally Used)

Fields

- +
gda_lisa

An object of GeoDaLISA

@@ -96,7 +96,7 @@

Fields

Methods

- +
GetBO(current_p)

Get the Bonferroni bound value

@@ -166,15 +166,15 @@

Methods

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/Weight-class.html b/reference/Weight-class.html index 68742d82..f0c3f84c 100644 --- a/reference/Weight-class.html +++ b/reference/Weight-class.html @@ -1,9 +1,9 @@ -Weight class (Internally Used) — Weight-class • rgeodaWeight class (Internally Used) — Weight-class • rgeoda - +
- +

Weight class (Internally Used)

- Source: R/weights.R + Source: R/weights.R
@@ -62,7 +62,7 @@

Weight class (Internally Used)

Fields

- +
gda_w

An object of p_GeoDaWeight-class

@@ -103,7 +103,7 @@

Fields

Methods

- +
GetNeighborWeights(idx)

Get weights values of neighbors for idx-th observation, @@ -175,15 +175,15 @@

Methods

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/as.data.frame.geoda.html b/reference/as.data.frame.geoda.html index 428db3b7..c1ae9b2d 100644 --- a/reference/as.data.frame.geoda.html +++ b/reference/as.data.frame.geoda.html @@ -1,9 +1,9 @@ -convert rgeoda instance to data.frame — as.data.frame.geoda • rgeodaconvert rgeoda instance to data.frame — as.data.frame.geoda • rgeoda - +
- +

convert rgeoda instance to data.frame

- Source: R/read_geoda.R + Source: R/read_geoda.R
@@ -60,34 +60,34 @@

convert rgeoda instance to data.frame

- 
# S3 method for geoda
+    
# S3 method for class 'geoda'
 as.data.frame(x, row.names = NULL, optional = FALSE, ...)

Arguments

-
x
+ + +
x

A rgeoda object

-
row.names
+
row.names

NULL or a character vector giving the row names for the data frame. Missing values are not allowed.

-
optional
+
optional

optional parameters

-
...
+
...

other arguments passed to methods

Value

- - -

A data.frame object

+

A data.frame object

@@ -102,15 +102,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/as.geoda.html b/reference/as.geoda.html index a046bd81..18435825 100644 --- a/reference/as.geoda.html +++ b/reference/as.geoda.html @@ -1,12 +1,12 @@ -Create an instance of geoda-class from either an 'sf' or 'sp' object — as.geoda • rgeodaCreate an instance of geoda-class from either an 'sf' or 'sp' object — as.geoda • rgeoda - +
- +

Create an instance of geoda-class from either an 'sf' or 'sp' object

- Source: R/sf_geoda.R + Source: R/sf_geoda.R
@@ -71,20 +71,20 @@

Create an instance of geoda-class from either an 'sf' or 'sp' object

Arguments

-
obj
+ + +
obj

An instance of 'sf' or 'sp' object

-
with_table
+
with_table

A boolean flag indicates if table is copied from sf object to create geoda object. Default is TRUE

Value

- - -

An instance of geoda-class

+

An instance of geoda-class

@@ -99,15 +99,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/as.matrix.Weight.html b/reference/as.matrix.Weight.html index 922cab25..456c7799 100644 --- a/reference/as.matrix.Weight.html +++ b/reference/as.matrix.Weight.html @@ -1,9 +1,9 @@ -spatial weights to matrix — as.matrix.Weight • rgeodaspatial weights to matrix — as.matrix.Weight • rgeoda - +
- +

spatial weights to matrix

- Source: R/weights.R + Source: R/weights.R
@@ -60,38 +60,38 @@

spatial weights to matrix

- 
# S3 method for Weight
+    
# S3 method for class 'Weight'
 as.matrix(x, rownames = NULL, rownames.value = NULL, ...)

Arguments

-
x
+ + +
x

A weights object

-
rownames
+
rownames

optional, a single column name or column number to use as the rownames in the returned matrix. If TRUE the key of the data.table will be used if it is a single column, otherwise the first column in the data.table will be used.

-
rownames.value
+
rownames.value

optional, a vector of values to be used as the rownames in the returned matrix. It must be the same length as nrow(x).

-
...
+
...

Required to be present because the generic `as.matrix` generic has it. Arguments here are not currently used or passed on by this method.

Value

- - -

A matrix object

+

A matrix object

@@ -106,15 +106,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/azp_greedy.html b/reference/azp_greedy.html index 297d66c3..3bd9f6a0 100644 --- a/reference/azp_greedy.html +++ b/reference/azp_greedy.html @@ -1,9 +1,9 @@ -A greedy algorithm to solve the AZP problem — azp_greedy • rgeodaA greedy algorithm to solve the AZP problem — azp_greedy • rgeoda - +
- +

A greedy algorithm to solve the AZP problem

- Source: R/clustering.R + Source: R/clustering.R
@@ -77,60 +77,60 @@

A greedy algorithm to solve the AZP problem

Arguments

-
p
+ + +
p

The number of spatially constrained clusters

-
w
+
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
bound_variable
+
bound_variable

(optional) A data frame with selected bound variabl

-
min_bound
+
min_bound

(optional) A minimum bound value that applies to all clusters

-
inits
+
inits

(optional) The number of construction re-runs, which is for ARiSeL "automatic regionalization with initial seed location"

-
initial_regions
+
initial_regions

(optional) The initial regions that the local search starts with. Default is empty. means the local search starts with a random process to "grow" clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(optional) The seed for random number generator. Defaults to 123456789.

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -138,7 +138,7 @@ 
Examples

 data <- guerry[c('Crm_prs','Crm_prp','Litercy','Donatns','Infants','Suicids')]
 azp_clusters <- azp_greedy(5, queen_w, data)
 azp_clusters
-}
+} # }
@@ -153,15 +153,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/azp_sa.html b/reference/azp_sa.html index 690d071c..d50b9c3d 100644 --- a/reference/azp_sa.html +++ b/reference/azp_sa.html @@ -1,9 +1,9 @@ -A simulated annealing algorithm to solve the AZP problem — azp_sa • rgeodaA simulated annealing algorithm to solve the AZP problem — azp_sa • rgeoda - +
- +

A simulated annealing algorithm to solve the AZP problem

- Source: R/clustering.R + Source: R/clustering.R
@@ -79,68 +79,68 @@

A simulated annealing algorithm to solve the AZP problem

Arguments

-
p
+ + +
p

The number of spatially constrained clusters

-
w
+
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
cooling_rate
+
cooling_rate

The cooling rate of a simulated annealing algorithm. Defaults to 0.85

-
sa_maxit
+
sa_maxit

(optional): The number of iterations of simulated annealing. Defaults to 1

-
bound_variable
+
bound_variable

(optional) A data frame with selected bound variabl

-
min_bound
+
min_bound

(optional) A minimum bound value that applies to all clusters

-
inits
+
inits

(optional) The number of construction re-runs, which is for ARiSeL "automatic regionalization with initial seed location"

-
initial_regions
+
initial_regions

(optional) The initial regions that the local search starts with. Default is empty. means the local search starts with a random process to "grow" clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(optional) The seed for random number generator. Defaults to 123456789.

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -148,7 +148,7 @@ 
Examples

 data <- guerry[c('Crm_prs','Crm_prp','Litercy','Donatns','Infants','Suicids')]
 azp_clusters <- azp_sa(5, queen_w, data, cooling_rate = 0.85)
 azp_clusters
-}
+} # }
@@ -163,15 +163,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/azp_tabu.html b/reference/azp_tabu.html index b6a05d59..6c59b616 100644 --- a/reference/azp_tabu.html +++ b/reference/azp_tabu.html @@ -1,9 +1,9 @@ -A tabu algorithm to solve the AZP problem — azp_tabu • rgeodaA tabu algorithm to solve the AZP problem — azp_tabu • rgeoda - +
- +

A tabu algorithm to solve the AZP problem

- Source: R/clustering.R + Source: R/clustering.R
@@ -79,68 +79,68 @@

A tabu algorithm to solve the AZP problem

Arguments

-
p
+ + +
p

The number of spatially constrained clusters

-
w
+
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
tabu_length
+
tabu_length

The length of a tabu search heuristic of tabu algorithm. e.g. 10.

-
conv_tabu
+
conv_tabu

(optional): The number of non-improving moves. Defaults to 10.

-
bound_variable
+
bound_variable

(optional) A data frame with selected bound variabl

-
min_bound
+
min_bound

(optional) A minimum bound value that applies to all clusters

-
inits
+
inits

(optional) The number of construction re-runs, which is for ARiSeL "automatic regionalization with initial seed location"

-
initial_regions
+
initial_regions

(optional) The initial regions that the local search starts with. Default is empty. means the local search starts with a random process to "grow" clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(optional) The seed for random number generator. Defaults to 123456789.

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -148,7 +148,7 @@ 
Examples

 data <- guerry[c('Crm_prs','Crm_prp','Litercy','Donatns','Infants','Suicids')]
 azp_clusters <- azp_tabu(5, queen_w, data, tabu_length=10, conv_tabu=10)
 azp_clusters
-}
+} # }
@@ -163,15 +163,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/create_weights.html b/reference/create_weights.html index 08b40c22..68cca9f7 100644 --- a/reference/create_weights.html +++ b/reference/create_weights.html @@ -1,9 +1,9 @@ -Create an empty weights — create_weights • rgeodaCreate an empty weights — create_weights • rgeoda - +
- +

Create an empty weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,15 +65,15 @@

Create an empty weights

Arguments

-
num_obs
+ + +
num_obs

The number of observations for this empty weights

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -88,15 +88,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/distance_weights.html b/reference/distance_weights.html index 407fc6b2..5cb60184 100644 --- a/reference/distance_weights.html +++ b/reference/distance_weights.html @@ -1,9 +1,9 @@ -Distance-based Spatial Weights — distance_weights • rgeodaDistance-based Spatial Weights — distance_weights • rgeoda - +
- +

Distance-based Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,39 +72,39 @@

Distance-based Spatial Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
dist_thres
+
dist_thres

A positive numeric value of distance threshold

-
power
+
power

(optional) The power (or exponent) of a number indicates how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -147,15 +147,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/eb_rates.html b/reference/eb_rates.html index d14f7e60..e9b51af2 100644 --- a/reference/eb_rates.html +++ b/reference/eb_rates.html @@ -1,10 +1,10 @@ -Empirical Bayes(EB) Rate — eb_rates • rgeodaEmpirical Bayes(EB) Rate — eb_rates • rgeoda - +
- +

Empirical Bayes(EB) Rate

- Source: R/utils.R + Source: R/utils.R
@@ -67,26 +67,26 @@

Empirical Bayes(EB) Rate

Arguments

-
df
+ + +
df

A data frame with two selected variable: one is "event", anothor is "base" variable. E.g. guerry[c("hr60", "po60")]

Value

- - -

A data.frame with two columns "EB Rate" and "IsNull".

+

A data.frame with two columns "EB Rate" and "IsNull".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 nat <- st_read("natregimes.shp")
 ebr <- eb_rates(nat[c("HR60", "PO60")])
 ebr
-}
+} # }
@@ -101,15 +101,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_distance_weights.html b/reference/gda_distance_weights.html index 2201ab71..a53b4b08 100644 --- a/reference/gda_distance_weights.html +++ b/reference/gda_distance_weights.html @@ -1,9 +1,9 @@ -(For internally use and test only) Distance-based Spatial Weights — gda_distance_weights • rgeoda(For internally use and test only) Distance-based Spatial Weights — gda_distance_weights • rgeoda - +
- +

(For internally use and test only) Distance-based Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,50 +72,50 @@

(For internally use and test only) Distance-based Spatial Weights

Arguments

-
geoda_obj
+ + +
geoda_obj

An instance of geoda-class

-
dist_thres
+
dist_thres

A positive numeric value of distance threshold

-
power
+
power

(optional) The power (or exponent) of a number indicates how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 dist_thres <- gda_min_distthreshold(guerry)
 dist_w <- gda_distance_weights(guerry, dist_thres)
 summary(dist_w)
-}
+} # }
@@ -130,15 +130,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_kernel_knn_weights.html b/reference/gda_kernel_knn_weights.html index 913eae89..4c050f58 100644 --- a/reference/gda_kernel_knn_weights.html +++ b/reference/gda_kernel_knn_weights.html @@ -1,10 +1,10 @@ -(For internally use and test only) K-NN Kernel Spatial Weights — gda_kernel_knn_weights • rgeoda(For internally use and test only) K-NN Kernel Spatial Weights — gda_kernel_knn_weights • rgeoda - +
- +

(For internally use and test only) K-NN Kernel Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -77,65 +77,65 @@

(For internally use and test only) K-NN Kernel Spatial Weights

Arguments

-
geoda_obj
+ + +
geoda_obj

An instance of geoda

-
k
+
k

a positive integer number for k-nearest neighbors

-
kernel_method
+
kernel_method

a string value, which has to be one of 'triangular', 'uniform', 'epanechnikov', 'quartic', 'gaussian'

-
adaptive_bandwidth
+
adaptive_bandwidth

(optional) TRUE (default) or FALSE: TRUE use adaptive bandwidth calculated using distance of k-nearest neithbors, FALSE use max distance of all observation to their k-nearest neighbors

-
use_kernel_diagonals
+
use_kernel_diagonals

(optional) FALSE (default) or TRUE, apply kernel on the diagonal of weights matrix

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 adptkernel_w = gda_kernel_knn_weights(guerry, 6, "uniform")
 summary(adptkernel_w)
-}
+} # }
@@ -150,15 +150,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_kernel_weights.html b/reference/gda_kernel_weights.html index c7b29f5d..26fde19c 100644 --- a/reference/gda_kernel_weights.html +++ b/reference/gda_kernel_weights.html @@ -1,12 +1,10 @@ -(For internally use and test only) Distance-based Kernel Spatial -Weights — gda_kernel_weights • rgeoda(For internally use and test only) Distance-based Kernel Spatial Weights — gda_kernel_weights • rgeoda - +
- +
-

(For internally use and test only) Distance-based Kernel Spatial -Weights

- Source: R/weights.R +

(For internally use and test only) Distance-based Kernel Spatial Weights

+ Source: R/weights.R
@@ -79,60 +76,60 @@

(For internally use and test only) Distance-based Kernel Spatial

Arguments

-
geoda_obj
+ + +
geoda_obj

An instance of geoda-class

-
bandwidth
+
bandwidth

A positive numeric value of bandwidth

-
kernel_method
+
kernel_method

a string value, which has to be one of 'triangular', 'uniform', 'epanechnikov', 'quartic', 'gaussian'

-
use_kernel_diagonals
+
use_kernel_diagonals

(optional) FALSE (default) or TRUE, apply kernel on the diagonal of weights matrix

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 bandwidth <- gda_min_distthreshold(guerry)
 kernel_w <- gda_kernel_weights(guerry, bandwidth, kernel_method = "uniform")
 summary(kernel_w)
-}
+} # }
@@ -147,15 +144,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_knn_weights.html b/reference/gda_knn_weights.html index 27dbe962..12de34ec 100644 --- a/reference/gda_knn_weights.html +++ b/reference/gda_knn_weights.html @@ -1,11 +1,9 @@ -(For internally use and test only) K-Nearest Neighbors-based Spatial -Weights — gda_knn_weights • rgeoda(For internally use and test only) K-Nearest Neighbors-based Spatial Weights — gda_knn_weights • rgeoda - +
- +
-

(For internally use and test only) K-Nearest Neighbors-based Spatial -Weights

- Source: R/weights.R +

(For internally use and test only) K-Nearest Neighbors-based Spatial Weights

+ Source: R/weights.R
@@ -75,49 +72,49 @@

(For internally use and test only) K-Nearest Neighbors-based Spatial

Arguments

-
geoda_obj
+ + +
geoda_obj

An instance of geoda

-
k
+
k

a positive integer number for k-nearest neighbors

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 knn6_w <- gda_knn_weights(guerry, 6)
 summary(knn6_w)
-}
+} # }
@@ -132,15 +129,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_min_distthreshold.html b/reference/gda_min_distthreshold.html index ba2da37c..f3164108 100644 --- a/reference/gda_min_distthreshold.html +++ b/reference/gda_min_distthreshold.html @@ -1,12 +1,10 @@ -(For internally use and test only) Minimum Distance Threshold for -Distance-based Weights — gda_min_distthreshold • rgeoda(For internally use and test only) Minimum Distance Threshold for Distance-based Weights — gda_min_distthreshold • rgeoda - +
- +
-

(For internally use and test only) Minimum Distance Threshold for -Distance-based Weights

- Source: R/weights.R +

(For internally use and test only) Minimum Distance Threshold for Distance-based Weights

+ Source: R/weights.R
@@ -70,25 +67,25 @@

(For internally use and test only) Minimum Distance Threshold for

Arguments

-
geoda_obj
+ + +
geoda_obj

An instance of geoda-class

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, if 'is_arc' option is TRUE, then 'is_mile' will set distance unit to 'mile' or 'km'.

Value

- - -

A numeric value of minimum threshold of distance

+

A numeric value of minimum threshold of distance

@@ -103,15 +100,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_queen_weights.html b/reference/gda_queen_weights.html index cb8c2395..801abd8b 100644 --- a/reference/gda_queen_weights.html +++ b/reference/gda_queen_weights.html @@ -1,10 +1,10 @@ -(For internally use and test only) Queen Contiguity Spatial Weights — gda_queen_weights • rgeoda - +
- +

(For internally use and test only) Queen Contiguity Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,20 +72,22 @@

(For internally use and test only) Queen Contiguity Spatial Weights

Arguments

-
geoda_obj
+ + +
geoda_obj

An object of [geoda] class

-
order
+
order

(Optional) Order of contiguity

-
include_lower_order
+
include_lower_order

(Optional) Whether or not the lower order neighbors should be included in the weights structure

-
precision_threshold
+
precision_threshold

(Optional) The precision of the underlying shape file is insufficient to allow for an exact match of coordinates to determine which polygons are neighbors

@@ -93,19 +95,17 @@

Arguments

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 queen_w <- gda_queen_weights(guerry)
 summary(queen_w)
-}
+} # }
@@ -120,15 +120,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/gda_rook_weights.html b/reference/gda_rook_weights.html index bf2e1628..3a2e0080 100644 --- a/reference/gda_rook_weights.html +++ b/reference/gda_rook_weights.html @@ -1,10 +1,10 @@ -(For internally use and test only) Rook Contiguity Spatial Weights — gda_rook_weights • rgeoda - +
- +

(For internally use and test only) Rook Contiguity Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,20 +72,22 @@

(For internally use and test only) Rook Contiguity Spatial Weights

Arguments

-
geoda_obj
+ + +
geoda_obj

An object of [geoda] class

-
order
+
order

(Optional) Order of contiguity

-
include_lower_order
+
include_lower_order

(Optional) Whether or not the lower order neighbors should be included in the weights structure

-
precision_threshold
+
precision_threshold

(Optional) The precision of the underlying shape file is insufficient to allow for an exact match of coordinates to determine which polygons are neighbors

@@ -93,19 +95,17 @@

Arguments

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 rook_w <- gda_rook_weights(guerry)
 summary(rook_w)
-}
+} # }
@@ -120,15 +120,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/geoda-class.html b/reference/geoda-class.html index 7b0bce14..fd947a75 100644 --- a/reference/geoda-class.html +++ b/reference/geoda-class.html @@ -1,10 +1,10 @@ -'geoda' class — geoda-class • rgeoda'geoda' class — geoda-class • rgeoda - +
- +

'geoda' class

- Source: R/read_geoda.R + Source: R/read_geoda.R
@@ -64,7 +64,7 @@

'geoda' class

Fields

- +
gda

The pointer to the instance of p_GeoDa-class

@@ -93,7 +93,7 @@

Fields

Methods

- +
GetFieldNames(...)

Get the field names of all columns

@@ -149,15 +149,15 @@

Methods

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/geoda_open.html b/reference/geoda_open.html index 9b771ec4..28a62593 100644 --- a/reference/geoda_open.html +++ b/reference/geoda_open.html @@ -1,12 +1,10 @@ -Create an instance of geoda-class by reading from an ESRI Shapefile -dataset — geoda_open • rgeodaCreate an instance of geoda-class by reading from an ESRI Shapefile dataset — geoda_open • rgeoda - +
- +
-

Create an instance of geoda-class by reading from an ESRI Shapefile -dataset

- Source: R/read_geoda.R +

Create an instance of geoda-class by reading from an ESRI Shapefile dataset

+ Source: R/read_geoda.R
@@ -70,25 +67,25 @@

Create an instance of geoda-class by reading from an ESRI Shapefile

Arguments

-
ds_path
+ + +
ds_path

(character) The path of the spatial dataset

Value

- - -

An instance of geoda-class

+

An instance of geoda-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- geoda_open(guerry_path)
 guerry_df <- as.data.frame(guerry) # access as a data.frame
 head(guerry_df)
-}
+} # }
@@ -103,15 +100,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_neighbors.html b/reference/get_neighbors.html index ba177157..41f57539 100644 --- a/reference/get_neighbors.html +++ b/reference/get_neighbors.html @@ -1,9 +1,9 @@ -Neighbors of one observation — get_neighbors • rgeodaNeighbors of one observation — get_neighbors • rgeoda - +
- +

Neighbors of one observation

- Source: R/weights.R + Source: R/weights.R
@@ -65,30 +65,30 @@

Neighbors of one observation

Arguments

-
gda_w
+ + +
gda_w

A Weight object

-
idx
+
idx

A value indicates idx-th observation, idx start from 1

Value

- - -

A numeric vector of the neighbor indices, which start from 1

+

A numeric vector of the neighbor indices, which start from 1

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 nbrs <- get_neighbors(queen_w, idx = 1)
 cat("\nNeighbors of the 1-st observation are:", nbrs)
-}
+} # }
@@ -103,15 +103,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/get_neighbors_weights.html b/reference/get_neighbors_weights.html index 6dd1d23d..a72fde69 100644 --- a/reference/get_neighbors_weights.html +++ b/reference/get_neighbors_weights.html @@ -1,10 +1,10 @@ -Weights values of the neighbors of one observation — get_neighbors_weights • rgeodaWeights values of the neighbors of one observation — get_neighbors_weights • rgeoda - +
- +

Weights values of the neighbors of one observation

- Source: R/weights.R + Source: R/weights.R
@@ -67,30 +67,30 @@

Weights values of the neighbors of one observation

Arguments

-
gda_w
+ + +
gda_w

A Weight object

-
idx
+
idx

A value indicates idx-th observation, idx start from 1

Value

- - -

A numeric vector of the neighbor indices, which start from 1

+

A numeric vector of the neighbor indices, which start from 1

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 nbrs <- get_neighbors_weights(queen_w, idx = 1)
 cat("\nNeighbors of the 1-st observation are:", nbrs)
-}
+} # }
@@ -105,15 +105,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/has_isolates.html b/reference/has_isolates.html index b6ff5e8a..027d1779 100644 --- a/reference/has_isolates.html +++ b/reference/has_isolates.html @@ -1,10 +1,10 @@ -Isolation/Island in Spatial Weights — has_isolates • rgeodaIsolation/Island in Spatial Weights — has_isolates • rgeoda - +
- +

Isolation/Island in Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -67,25 +67,25 @@

Isolation/Island in Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

A boolean value indicates if weights matrix is symmetric

+

A boolean value indicates if weights matrix is symmetric

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 has_isolates(queen_w)
-}
+} # }
@@ -100,15 +100,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/hinge15_breaks.html b/reference/hinge15_breaks.html index 5a822c68..91c3e8b1 100644 --- a/reference/hinge15_breaks.html +++ b/reference/hinge15_breaks.html @@ -1,10 +1,10 @@ -(Box) Hinge15 Breaks — hinge15_breaks • rgeoda(Box) Hinge15 Breaks — hinge15_breaks • rgeoda - +
- +

(Box) Hinge15 Breaks

- Source: R/utils.R + Source: R/utils.R
@@ -67,15 +67,15 @@

(Box) Hinge15 Breaks

Arguments

-
df
+ + +
df

A data frame with selected variable. E.g. guerry["Crm_prs"]

Value

- - -

A vector of numeric values of computed breaks

+

A vector of numeric values of computed breaks

@@ -107,15 +107,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/hinge30_breaks.html b/reference/hinge30_breaks.html index a4cd2d14..9f640630 100644 --- a/reference/hinge30_breaks.html +++ b/reference/hinge30_breaks.html @@ -1,10 +1,10 @@ -(Box) Hinge30 Breaks — hinge30_breaks • rgeoda(Box) Hinge30 Breaks — hinge30_breaks • rgeoda - +
- +

(Box) Hinge30 Breaks

- Source: R/utils.R + Source: R/utils.R
@@ -67,15 +67,15 @@

(Box) Hinge30 Breaks

Arguments

-
df
+ + +
df

A data frame with selected variable. E.g. guerry["Crm_prs"]

Value

- - -

A vector of numeric values of computed breaks

+

A vector of numeric values of computed breaks

@@ -107,15 +107,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/index.html b/reference/index.html index 678a201a..7788c50e 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • rgeodaPackage index • rgeoda - +
- +
@@ -112,18 +112,15 @@

All functions

gda_kernel_weights()

-

(For internally use and test only) Distance-based Kernel Spatial -Weights

+

(For internally use and test only) Distance-based Kernel Spatial Weights

gda_knn_weights()

-

(For internally use and test only) K-Nearest Neighbors-based Spatial -Weights

+

(For internally use and test only) K-Nearest Neighbors-based Spatial Weights

gda_min_distthreshold()

-

(For internally use and test only) Minimum Distance Threshold for -Distance-based Weights

+

(For internally use and test only) Minimum Distance Threshold for Distance-based Weights

gda_queen_weights()

@@ -139,8 +136,7 @@

All functions

geoda_open()

-

Create an instance of geoda-class by reading from an ESRI Shapefile -dataset

+

Create an instance of geoda-class by reading from an ESRI Shapefile dataset

get_neighbors()

@@ -418,15 +414,15 @@

All functions
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/is_symmetric.html b/reference/is_symmetric.html index 5649361a..3276087d 100644 --- a/reference/is_symmetric.html +++ b/reference/is_symmetric.html @@ -1,9 +1,9 @@ -Symmetry of Weights Matrix — is_symmetric • rgeodaSymmetry of Weights Matrix — is_symmetric • rgeoda - +
- +

Symmetry of Weights Matrix

- Source: R/weights.R + Source: R/weights.R
@@ -65,25 +65,25 @@

Symmetry of Weights Matrix

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

A boolean value indicates if weights matrix is symmetric

+

A boolean value indicates if weights matrix is symmetric

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 is_symmetric(queen_w)
-}
+} # }
@@ -98,15 +98,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/join_count_ratio.html b/reference/join_count_ratio.html index 47a3a812..7b2abb6c 100644 --- a/reference/join_count_ratio.html +++ b/reference/join_count_ratio.html @@ -1,11 +1,11 @@ -Join Count Ratio — join_count_ratio • rgeodaJoin Count Ratio — join_count_ratio • rgeoda - +
- +

Join Count Ratio

- Source: R/clustering.R + Source: R/clustering.R
@@ -69,24 +69,24 @@

Join Count Ratio

Arguments

-
clusters
+ + +
clusters

A cluster classification variable (categorical values from a dataframe or values returned from cluster functions)

-
w
+
w

An instance of Weight class

Value

- - -

A data.frame with names "Cluster", "N", "Neighbors", "Join Count", "Ratio"

+

A data.frame with names "Cluster", "N", "Neighbors", "Join Count", "Ratio"

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -95,7 +95,7 @@ 
Examples

 clusters <- skater(5, queen_w, data)
 results <- join_count_ratio(clusters, queen_w)
 results
-}
+} # }
@@ -110,15 +110,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/kernel_knn_weights.html b/reference/kernel_knn_weights.html index 0608756b..593f56c1 100644 --- a/reference/kernel_knn_weights.html +++ b/reference/kernel_knn_weights.html @@ -1,10 +1,10 @@ -K-NN Kernel Spatial Weights — kernel_knn_weights • rgeodaK-NN Kernel Spatial Weights — kernel_knn_weights • rgeoda - +
- +

K-NN Kernel Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -77,55 +77,55 @@

K-NN Kernel Spatial Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
k
+
k

a positive integer number for k-nearest neighbors

-
kernel_method
+
kernel_method

a string value, which has to be one of 'triangular', 'uniform', 'epanechnikov', 'quartic', 'gaussian'

-
adaptive_bandwidth
+
adaptive_bandwidth

(optional) TRUE (default) or FALSE: TRUE use adaptive bandwidth calculated using distance of k-nearest neithbors, FALSE use max distance of all observation to their k-nearest neighbors

-
use_kernel_diagonals
+
use_kernel_diagonals

(optional) FALSE (default) or TRUE, apply kernel on the diagonal of weights matrix

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -166,15 +166,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/kernel_weights.html b/reference/kernel_weights.html index c11aa2ef..3753838f 100644 --- a/reference/kernel_weights.html +++ b/reference/kernel_weights.html @@ -1,10 +1,10 @@ -Distance-based Kernel Spatial Weights — kernel_weights • rgeodaDistance-based Kernel Spatial Weights — kernel_weights • rgeoda - +
- +

Distance-based Kernel Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -76,49 +76,49 @@

Distance-based Kernel Spatial Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
bandwidth
+
bandwidth

A positive numeric value of bandwidth

-
kernel_method
+
kernel_method

a string value, which has to be one of 'triangular', 'uniform', 'epanechnikov', 'quartic', 'gaussian'

-
use_kernel_diagonals
+
use_kernel_diagonals

(optional) FALSE (default) or TRUE, apply kernel on the diagonal of weights matrix

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -160,15 +160,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/knn_weights.html b/reference/knn_weights.html index 31aa69d8..967f0dd9 100644 --- a/reference/knn_weights.html +++ b/reference/knn_weights.html @@ -1,9 +1,9 @@ -K-Nearest Neighbors-based Spatial Weights — knn_weights • rgeodaK-Nearest Neighbors-based Spatial Weights — knn_weights • rgeoda - +
- +

K-Nearest Neighbors-based Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,39 +72,39 @@

K-Nearest Neighbors-based Spatial Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
k
+
k

a positive integer number for k-nearest neighbors

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -145,15 +145,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_bo.html b/reference/lisa_bo.html index a255e526..d9d39e96 100644 --- a/reference/lisa_bo.html +++ b/reference/lisa_bo.html @@ -1,10 +1,10 @@ -Bonferroni bound value of local spatial autocorrelation — lisa_bo • rgeodaBonferroni bound value of local spatial autocorrelation — lisa_bo • rgeoda - +
- +

Bonferroni bound value of local spatial autocorrelation

- Source: R/lisa.R + Source: R/lisa.R
@@ -67,24 +67,24 @@

Bonferroni bound value of local spatial autocorrelation

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

-
current_p
+
current_p

A value of current siginificant p-value

Value

- - -

A numeric value of Bonferroni bound

+

A numeric value of Bonferroni bound

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -92,7 +92,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 bo <- lisa_bo(lisa, 0.05)
 bo
-}
+} # }
@@ -107,15 +107,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_clusters.html b/reference/lisa_clusters.html index 028be063..a4cb1227 100644 --- a/reference/lisa_clusters.html +++ b/reference/lisa_clusters.html @@ -1,9 +1,9 @@ -Get local cluster indicators — lisa_clusters • rgeodaGet local cluster indicators — lisa_clusters • rgeoda - +
- +

Get local cluster indicators

- Source: R/lisa.R + Source: R/lisa.R
@@ -65,25 +65,25 @@

Get local cluster indicators

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

-
cutoff
+
cutoff

A value of cutoff for significance p-values to filter not-significant clusters, default=0.0, means not used

Value

- - -

A numeric vector of LISA cluster indicator

+

A numeric vector of LISA cluster indicator

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -91,7 +91,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 clsts <- lisa_clusters(lisa)
 clsts
-}
+} # }
@@ -106,15 +106,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_colors.html b/reference/lisa_colors.html index 80e2d6a0..f2efc01f 100644 --- a/reference/lisa_colors.html +++ b/reference/lisa_colors.html @@ -1,9 +1,9 @@ -Get cluster colors — lisa_colors • rgeodaGet cluster colors — lisa_colors • rgeoda - +
- +

Get cluster colors

- Source: R/lisa.R + Source: R/lisa.R
@@ -65,20 +65,20 @@

Get cluster colors

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

Value

- - -

A string vector of cluster colors

+

A string vector of cluster colors

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -86,7 +86,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 clrs <- lisa_colors(lisa)
 clrs
-}
+} # }
@@ -101,15 +101,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_fdr.html b/reference/lisa_fdr.html index b4f61511..cf4c1923 100644 --- a/reference/lisa_fdr.html +++ b/reference/lisa_fdr.html @@ -1,10 +1,10 @@ -False Discovery Rate value of local spatial autocorrelation — lisa_fdr • rgeodaFalse Discovery Rate value of local spatial autocorrelation — lisa_fdr • rgeoda - +
- +

False Discovery Rate value of local spatial autocorrelation

- Source: R/lisa.R + Source: R/lisa.R
@@ -67,24 +67,24 @@

False Discovery Rate value of local spatial autocorrelation

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

-
current_p
+
current_p

A value of current siginificant p-value

Value

- - -

A numeric vector of False Discovery Rate

+

A numeric vector of False Discovery Rate

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -92,7 +92,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 fdr <- lisa_fdr(lisa, 0.05)
 fdr
-}
+} # }
@@ -107,15 +107,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_labels.html b/reference/lisa_labels.html index e651379d..62e25392 100644 --- a/reference/lisa_labels.html +++ b/reference/lisa_labels.html @@ -1,9 +1,9 @@ -Get cluster labels — lisa_labels • rgeodaGet cluster labels — lisa_labels • rgeoda - +
- +

Get cluster labels

- Source: R/lisa.R + Source: R/lisa.R
@@ -65,20 +65,20 @@

Get cluster labels

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

Value

- - -

A string vector of cluster labels

+

A string vector of cluster labels

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -86,7 +86,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 lbls <- lisa_labels(lisa)
 lbls
-}
+} # }
@@ -101,15 +101,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_num_nbrs.html b/reference/lisa_num_nbrs.html index 8d1b2596..9ae9c451 100644 --- a/reference/lisa_num_nbrs.html +++ b/reference/lisa_num_nbrs.html @@ -1,9 +1,9 @@ -Get numbers of neighbors for all observations — lisa_num_nbrs • rgeodaGet numbers of neighbors for all observations — lisa_num_nbrs • rgeoda - +
- +

Get numbers of neighbors for all observations

- Source: R/lisa.R + Source: R/lisa.R
@@ -65,20 +65,20 @@

Get numbers of neighbors for all observations

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

Value

- - -

A numeric vector of the number of neighbors

+

A numeric vector of the number of neighbors

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -86,7 +86,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 nn <- lisa_num_nbrs(lisa)
 nn
-}
+} # }
@@ -101,15 +101,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_pvalues.html b/reference/lisa_pvalues.html index 00762ef8..b06fa5b0 100644 --- a/reference/lisa_pvalues.html +++ b/reference/lisa_pvalues.html @@ -1,10 +1,10 @@ -Get pseudo-p values of LISA — lisa_pvalues • rgeodaGet pseudo-p values of LISA — lisa_pvalues • rgeoda - +
- +

Get pseudo-p values of LISA

- Source: R/lisa.R + Source: R/lisa.R
@@ -67,20 +67,20 @@

Get pseudo-p values of LISA

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

Value

- - -

A numeric vector of pseudo-p values of local spatial autocorrelation

+

A numeric vector of pseudo-p values of local spatial autocorrelation

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -88,7 +88,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 pvals <- lisa_pvalues(lisa)
 pvals
-}
+} # }
@@ -103,15 +103,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/lisa_values.html b/reference/lisa_values.html index 52e4f79c..eb06062b 100644 --- a/reference/lisa_values.html +++ b/reference/lisa_values.html @@ -1,10 +1,10 @@ -Get LISA values — lisa_values • rgeodaGet LISA values — lisa_values • rgeoda - +
- +

Get LISA values

- Source: R/lisa.R + Source: R/lisa.R
@@ -67,20 +67,20 @@

Get LISA values

Arguments

-
gda_lisa
+ + +
gda_lisa

An instance of LISA object

Value

- - -

A numeric vector of local spatial autocorrelation

+

A numeric vector of local spatial autocorrelation

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -88,7 +88,7 @@ 
Examples

 lisa <- local_moran(queen_w, guerry["Crm_prs"])
 lms <- lisa_values(lisa)
 lms
-}
+} # }
@@ -103,15 +103,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_bijoincount.html b/reference/local_bijoincount.html index 344ce5b4..0e38ffb7 100644 --- a/reference/local_bijoincount.html +++ b/reference/local_bijoincount.html @@ -1,9 +1,9 @@ -Bivariate Local Join Count Statistics — local_bijoincount • rgeodaBivariate Local Join Count Statistics — local_bijoincount • rgeoda - +
- +

Bivariate Local Join Count Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,44 +73,44 @@

Bivariate Local Join Count Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with two selected variable. E.g. guerry[c("TopCrm", "InvCrm")]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -148,15 +148,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_bimoran.html b/reference/local_bimoran.html index 1b0a8d4d..eff45dbc 100644 --- a/reference/local_bimoran.html +++ b/reference/local_bimoran.html @@ -1,9 +1,9 @@ -Bivariate Local Moran Statistics — local_bimoran • rgeodaBivariate Local Moran Statistics — local_bimoran • rgeoda - +
- +

Bivariate Local Moran Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Bivariate Local Moran Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with two selected variable. E.g. guerry[c('Crm_prs','Litercy')]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -160,15 +160,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_g.html b/reference/local_g.html index 2f5c5a04..ff96e924 100644 --- a/reference/local_g.html +++ b/reference/local_g.html @@ -1,9 +1,9 @@ -Local Getis-Ord's G Statistics — local_g • rgeodaLocal Getis-Ord's G Statistics — local_g • rgeoda - +
- +

Local Getis-Ord's G Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Local Getis-Ord's G Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variable only. E.g. guerry["Crm_prs"]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -158,15 +158,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_geary.html b/reference/local_geary.html index 816a2d85..f3ba5ff1 100644 --- a/reference/local_geary.html +++ b/reference/local_geary.html @@ -1,9 +1,9 @@ -Local Geary Statistics — local_geary • rgeodaLocal Geary Statistics — local_geary • rgeoda - +
- +

Local Geary Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Local Geary Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variable only. E.g. guerry["Crm_prs"]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -158,15 +158,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_gstar.html b/reference/local_gstar.html index 92c7603e..78ae0cd0 100644 --- a/reference/local_gstar.html +++ b/reference/local_gstar.html @@ -1,9 +1,9 @@ -Local Getis-Ord's G* Statistics — local_gstar • rgeodaLocal Getis-Ord's G* Statistics — local_gstar • rgeoda - +
- +

Local Getis-Ord's G* Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Local Getis-Ord's G* Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variable only. E.g. guerry["Crm_prs"]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -158,15 +158,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_joincount.html b/reference/local_joincount.html index d5498676..6dc9d64f 100644 --- a/reference/local_joincount.html +++ b/reference/local_joincount.html @@ -1,9 +1,9 @@ -Local Join Count Statistics — local_joincount • rgeodaLocal Join Count Statistics — local_joincount • rgeoda - +
- +

Local Join Count Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Local Join Count Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variable only. E.g. guerry["Crm_prs"]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -146,15 +146,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_moran.html b/reference/local_moran.html index 59c34fc9..824fac51 100644 --- a/reference/local_moran.html +++ b/reference/local_moran.html @@ -1,9 +1,9 @@ -Local Moran Statistics — local_moran • rgeodaLocal Moran Statistics — local_moran • rgeoda - +
- +

Local Moran Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Local Moran Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with only selected variable. E.g. guerry["Crm_prs"]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -160,15 +160,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_moran_eb.html b/reference/local_moran_eb.html index 62bd4321..aa17dbb9 100644 --- a/reference/local_moran_eb.html +++ b/reference/local_moran_eb.html @@ -1,11 +1,11 @@ -Local Moran with Empirical Bayes(EB) Rate — local_moran_eb • rgeoda - +
- +

Local Moran with Empirical Bayes(EB) Rate

- Source: R/lisa.R + Source: R/lisa.R
@@ -77,56 +77,56 @@

Local Moran with Empirical Bayes(EB) Rate

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with two selected variable: one is "event", anothor is "base" variable. E.g. guerry[c("hr60", "po60")]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 nat <- st_read("natregimes.shp")
 nat_w <- queen_weights(nat)
 lisa <- local_moran_eb(queen_w, guerry[c("hr60", "po60")])
 lms <- lisa_values(lisa)
 lms
-}
+} # }
@@ -141,15 +141,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_multigeary.html b/reference/local_multigeary.html index db2946a4..d496bf8d 100644 --- a/reference/local_multigeary.html +++ b/reference/local_multigeary.html @@ -1,9 +1,9 @@ -Local Multivariate Geary Statistics — local_multigeary • rgeodaLocal Multivariate Geary Statistics — local_multigeary • rgeoda - +
- +

Local Multivariate Geary Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -73,43 +73,43 @@

Local Multivariate Geary Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variables only. E.g. guerry["Crm_prs"]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -148,15 +148,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_multijoincount.html b/reference/local_multijoincount.html index d141a615..20e5ae6f 100644 --- a/reference/local_multijoincount.html +++ b/reference/local_multijoincount.html @@ -1,10 +1,10 @@ -(Multivariate) Colocation Local Join Count Statistics — local_multijoincount • rgeoda(Multivariate) Colocation Local Join Count Statistics — local_multijoincount • rgeoda - +
- +

(Multivariate) Colocation Local Join Count Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -75,44 +75,44 @@

(Multivariate) Colocation Local Join Count Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("TopCrm", "TopWealth", "TopLit")]

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -150,15 +150,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_multiquantilelisa.html b/reference/local_multiquantilelisa.html index 6cb22122..86035551 100644 --- a/reference/local_multiquantilelisa.html +++ b/reference/local_multiquantilelisa.html @@ -1,9 +1,9 @@ -Multivariate Quantile LISA Statistics — local_multiquantilelisa • rgeodaMultivariate Quantile LISA Statistics — local_multiquantilelisa • rgeoda - +
- +

Multivariate Quantile LISA Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -75,54 +75,54 @@

Multivariate Quantile LISA Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("TopCrm", "TopWealth", "TopLit")]

-
k
+
k

A vector of "k" values indicate the number of quantiles for each variable. Value range e.g. [1, 10]

-
q
+
q

A vector of "q" values indicate which quantile or interval for each variable used in local join count statistics. Value stars from 1.

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -160,15 +160,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/local_quantilelisa.html b/reference/local_quantilelisa.html index 68fd44c9..54028256 100644 --- a/reference/local_quantilelisa.html +++ b/reference/local_quantilelisa.html @@ -1,9 +1,9 @@ -Quantile LISA Statistics — local_quantilelisa • rgeodaQuantile LISA Statistics — local_quantilelisa • rgeoda - +
- +

Quantile LISA Statistics

- Source: R/lisa.R + Source: R/lisa.R
@@ -75,52 +75,52 @@

Quantile LISA Statistics

Arguments

-
w
+ + +
w

An instance of Weight object

-
df
+
df

A data frame with selected variable only. E.g. guerry["Crm_prs"]

-
k
+
k

A value indicates the number of quantiles. Value range e.g. [1, 10]

-
q
+
q

A value indicates which quantile or interval used in local join count statistics. Value stars from 1.

-
permutations
+
permutations

(optional) The number of permutations for the LISA computation

-
permutation_method
+
permutation_method

(optional) The permutation method used for the LISA computation. Options are 'complete', 'lookup'. Default is 'complete'.

-
significance_cutoff
+
significance_cutoff

(optional) A cutoff value for significance p-values to filter not-significant clusters

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel LISA computation

-
seed
+
seed

(optional) The seed for random number generator

Value

- - -

An instance of LISA-class

+

An instance of LISA-class

@@ -157,15 +157,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/make_spatial.html b/reference/make_spatial.html index c6a82530..8c7453f1 100644 --- a/reference/make_spatial.html +++ b/reference/make_spatial.html @@ -1,10 +1,10 @@ -Make Spatial — make_spatial • rgeodaMake Spatial — make_spatial • rgeoda - +
- +

Make Spatial

- Source: R/clustering.R + Source: R/clustering.R
@@ -67,24 +67,24 @@

Make Spatial

Arguments

-
clusters
+ + +
clusters

A cluster classification variable (categorical values from a dataframe or values returned from cluster functions)

-
w
+
w

An instance of Weight class

Value

- - -

A vector of categorical values (cluster classification)

+

A vector of categorical values (cluster classification)

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -93,7 +93,7 @@ 
Examples

 queen_w <- queen_weights(guerry)
 results <- make_spatial(clusters, queen_w)
 results
-}
+} # }
@@ -108,15 +108,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/max_neighbors.html b/reference/max_neighbors.html index d413b1c7..d676b795 100644 --- a/reference/max_neighbors.html +++ b/reference/max_neighbors.html @@ -1,9 +1,9 @@ -Maximum Neighbors of Spatial Weights — max_neighbors • rgeodaMaximum Neighbors of Spatial Weights — max_neighbors • rgeoda - +
- +

Maximum Neighbors of Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,26 +65,26 @@

Maximum Neighbors of Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

The number of maximum neighbors of spatial weights

+

The number of maximum neighbors of spatial weights

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 max_neighbors(queen_w)
-}
+} # }
@@ -99,15 +99,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/maxp_greedy.html b/reference/maxp_greedy.html index bf7d02f0..2df9cf54 100644 --- a/reference/maxp_greedy.html +++ b/reference/maxp_greedy.html @@ -1,12 +1,12 @@ -A greedy algorithm to solve the max-p-region problem — maxp_greedy • rgeodaA greedy algorithm to solve the max-p-region problem — maxp_greedy • rgeoda - +
- +

A greedy algorithm to solve the max-p-region problem

- Source: R/clustering.R + Source: R/clustering.R
@@ -83,60 +83,60 @@

A greedy algorithm to solve the max-p-region problem

Arguments

-
w
+ + +
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
bound_variable
+
bound_variable

A numeric vector of selected bounding variable

-
min_bound
+
min_bound

A minimum value that the sum value of bounding variable int each cluster should be greater than

-
iterations
+
iterations

(optional): The number of iterations of greedy algorithm. Defaults to 99.

-
initial_regions
+
initial_regions

(optional): The initial regions that the local search starts with. Default is empty. means the local search starts with a random process to "grow" clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(optional) The seed for random number generator. Defaults to 123456789.

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel computation

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -146,7 +146,7 @@ 
Examples

 min_bound <- 3236.67 # 10% of Pop1831
 maxp_clusters <- maxp_greedy(queen_w, data, bound_variable, min_bound, iterations=99)
 maxp_clusters
-}
+} # }
@@ -161,15 +161,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/maxp_sa.html b/reference/maxp_sa.html index ddc33a65..770372c2 100644 --- a/reference/maxp_sa.html +++ b/reference/maxp_sa.html @@ -1,12 +1,12 @@ -A simulated annealing algorithm to solve the max-p-region problem — maxp_sa • rgeodaA simulated annealing algorithm to solve the max-p-region problem — maxp_sa • rgeoda - +
- +

A simulated annealing algorithm to solve the max-p-region problem

- Source: R/clustering.R + Source: R/clustering.R
@@ -85,68 +85,68 @@

A simulated annealing algorithm to solve the max-p-region problem

Arguments

-
w
+ + +
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
bound_variable
+
bound_variable

A numeric vector of selected bounding variable

-
min_bound
+
min_bound

A minimum value that the sum value of bounding variable int each cluster should be greater than

-
cooling_rate
+
cooling_rate

The cooling rate of a simulated annealing algorithm. Defaults to 0.85

-
sa_maxit
+
sa_maxit

(optional): The number of iterations of simulated annealing. Defaults to 1

-
iterations
+
iterations

(optional): The number of iterations of SA algorithm. Defaults to 99.

-
initial_regions
+
initial_regions

(optional): The initial regions that the local search starts with. Default is empty. means the local search starts with a random process to "grow" clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(optional) The seed for random number generator. Defaults to 123456789.

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel computation

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -156,7 +156,7 @@ 
Examples

 min_bound <- 3236.67 # 10% of Pop1831
 maxp_clusters <- maxp_sa(queen_w, data, bound_variable, min_bound, cooling_rate=0.85, sa_maxit=1)
 maxp_clusters
-}
+} # }
@@ -171,15 +171,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/maxp_tabu.html b/reference/maxp_tabu.html index 025de2c7..649cf310 100644 --- a/reference/maxp_tabu.html +++ b/reference/maxp_tabu.html @@ -1,12 +1,12 @@ -A tabu-search algorithm to solve the max-p-region problem — maxp_tabu • rgeodaA tabu-search algorithm to solve the max-p-region problem — maxp_tabu • rgeoda - +
- +

A tabu-search algorithm to solve the max-p-region problem

- Source: R/clustering.R + Source: R/clustering.R
@@ -85,68 +85,68 @@

A tabu-search algorithm to solve the max-p-region problem

Arguments

-
w
+ + +
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
bound_variable
+
bound_variable

A numeric vector of selected bounding variable

-
min_bound
+
min_bound

A minimum value that the sum value of bounding variable int each cluster should be greater than

-
tabu_length
+
tabu_length

(optional): The length of a tabu search heuristic of tabu algorithm. Defaults to 10.

-
conv_tabu
+
conv_tabu

(optional): The number of non-improving moves. Defaults to 10.

-
iterations
+
iterations

(optional): The number of iterations of Tabu algorithm. Defaults to 99.

-
initial_regions
+
initial_regions

(optional): The initial regions that the local search starts with. Default is empty. means the local search starts with a random process to "grow" clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(optional) The seed for random number generator. Defaults to 123456789.

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel computation

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -156,7 +156,7 @@ 
Examples

 min_bound <- 3236.67 # 10% of Pop1831
 maxp_clusters <- maxp_tabu(queen_w, data, bound_variable, min_bound, tabu_length=10, conv_tabu=10)
 maxp_clusters
-}
+} # }
@@ -171,15 +171,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/mean_neighbors.html b/reference/mean_neighbors.html index 4edbaa6c..014ab602 100644 --- a/reference/mean_neighbors.html +++ b/reference/mean_neighbors.html @@ -1,9 +1,9 @@ -Mean Neighbors of Spatial Weights — mean_neighbors • rgeodaMean Neighbors of Spatial Weights — mean_neighbors • rgeoda - +
- +

Mean Neighbors of Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,26 +65,26 @@

Mean Neighbors of Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

The number of mean neighbors of spatial weights

+

The number of mean neighbors of spatial weights

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 mean_neighbors(queen_w)
-}
+} # }
@@ -99,15 +99,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/median_neighbors.html b/reference/median_neighbors.html index e10f81ef..7e9849d4 100644 --- a/reference/median_neighbors.html +++ b/reference/median_neighbors.html @@ -1,9 +1,9 @@ -Median Neighbors of Spatial Weights — median_neighbors • rgeodaMedian Neighbors of Spatial Weights — median_neighbors • rgeoda - +
- +

Median Neighbors of Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,26 +65,26 @@

Median Neighbors of Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

The number of median neighbors of spatial weights

+

The number of median neighbors of spatial weights

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 median_neighbors(queen_w)
-}
+} # }
@@ -99,15 +99,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/min_distthreshold.html b/reference/min_distthreshold.html index 5ee1c98e..7b6d2820 100644 --- a/reference/min_distthreshold.html +++ b/reference/min_distthreshold.html @@ -1,10 +1,10 @@ -Minimum Distance Threshold for Distance-based Weights — min_distthreshold • rgeodaMinimum Distance Threshold for Distance-based Weights — min_distthreshold • rgeoda - +
- +

Minimum Distance Threshold for Distance-based Weights

- Source: R/weights.R + Source: R/weights.R
@@ -67,36 +67,36 @@

Minimum Distance Threshold for Distance-based Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, if 'is_arc' option is TRUE, then 'is_mile' will set distance unit to 'mile' or 'km'.

Value

- - -

A numeric value of minimum threshold of distance

+

A numeric value of minimum threshold of distance

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 dist_thres <- min_distthreshold(guerry)
 dist_thres
-}
+} # }
@@ -111,15 +111,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/min_neighbors.html b/reference/min_neighbors.html index 1b95b28e..faff977d 100644 --- a/reference/min_neighbors.html +++ b/reference/min_neighbors.html @@ -1,9 +1,9 @@ -Minimum Neighbors of Spatial Weights — min_neighbors • rgeodaMinimum Neighbors of Spatial Weights — min_neighbors • rgeoda - +
- +

Minimum Neighbors of Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,26 +65,26 @@

Minimum Neighbors of Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

The number of minimum neighbors of spatial weights

+

The number of minimum neighbors of spatial weights

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 min_neighbors(queen_w)
-}
+} # }
@@ -99,15 +99,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/natural_breaks.html b/reference/natural_breaks.html index 326227e9..89cbbf0d 100644 --- a/reference/natural_breaks.html +++ b/reference/natural_breaks.html @@ -1,10 +1,10 @@ -Natural Breaks (Jenks) — natural_breaks • rgeodaNatural Breaks (Jenks) — natural_breaks • rgeoda - +
- +

Natural Breaks (Jenks)

- Source: R/utils.R + Source: R/utils.R
@@ -67,19 +67,19 @@

Natural Breaks (Jenks)

Arguments

-
k
+ + +
k

A numeric value indicates how many breaks

-
df
+
df

A data frame with selected variable. E.g. guerry["Crm_prs"]

Value

- - -

A vector of numeric values of computed breaks

+

A vector of numeric values of computed breaks

@@ -111,15 +111,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/neighbor_match_test.html b/reference/neighbor_match_test.html index 6b0be5ca..3c45ad14 100644 --- a/reference/neighbor_match_test.html +++ b/reference/neighbor_match_test.html @@ -1,11 +1,11 @@ -Local Neighbor Match Test — neighbor_match_test • rgeodaLocal Neighbor Match Test — neighbor_match_test • rgeoda - +
- +

Local Neighbor Match Test

- Source: R/lisa.R + Source: R/lisa.R
@@ -78,51 +78,51 @@

Local Neighbor Match Test

Arguments

-
df
+ + +
df

A subset of sf object with selected variables. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
k
+
k

a positive integer number for k-nearest neighbors searching.

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The type of distance metrics used to measure the distance between input data. Options are 'euclidean', 'manhattan'. Default is 'euclidean'.

-
power
+
power

(optional) The power (or exponent) of a number says how many times to use the number in a multiplication.

-
is_inverse
+
is_inverse

(optional) FALSE (default) or TRUE, apply inverse on distance value.

-
is_arc
+
is_arc

(optional) FALSE (default) or TRUE, compute arc distance between two observations.

-
is_mile
+
is_mile

(optional) TRUE (default) or FALSE, convert distance unit from mile to km.

Value

- - -

A data.frame with two columns "Cardinality" and "Probability".

+

A data.frame with two columns "Cardinality" and "Probability".

@@ -241,15 +241,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/p_GeoDa-class.html b/reference/p_GeoDa-class.html index 151ca7c3..6326ccd1 100644 --- a/reference/p_GeoDa-class.html +++ b/reference/p_GeoDa-class.html @@ -1,10 +1,10 @@ -p_GeoDa — p_GeoDa-class • rgeodap_GeoDa — p_GeoDa-class • rgeoda - +
- +

p_GeoDa

- Source: R/rgeoda.R + Source: R/rgeoda.R
@@ -75,15 +75,15 @@

p_GeoDa

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/p_GeoDaTable-class.html b/reference/p_GeoDaTable-class.html index 908104bc..8b412843 100644 --- a/reference/p_GeoDaTable-class.html +++ b/reference/p_GeoDaTable-class.html @@ -1,11 +1,11 @@ -p_GeoDaTable — p_GeoDaTable-class • rgeodap_GeoDaTable — p_GeoDaTable-class • rgeoda - +
- +

p_GeoDaTable

- Source: R/rgeoda.R + Source: R/rgeoda.R
@@ -77,15 +77,15 @@

p_GeoDaTable

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/p_GeoDaWeight-class.html b/reference/p_GeoDaWeight-class.html index 3470deee..67e68138 100644 --- a/reference/p_GeoDaWeight-class.html +++ b/reference/p_GeoDaWeight-class.html @@ -1,11 +1,11 @@ -p_GeoDaWeight — p_GeoDaWeight-class • rgeodap_GeoDaWeight — p_GeoDaWeight-class • rgeoda - +
- +

p_GeoDaWeight

- Source: R/rgeoda.R + Source: R/rgeoda.R
@@ -77,15 +77,15 @@

p_GeoDaWeight

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/p_LISA-class.html b/reference/p_LISA-class.html index 42c97c8d..404ff2ca 100644 --- a/reference/p_LISA-class.html +++ b/reference/p_LISA-class.html @@ -1,10 +1,10 @@ -p_LISA — p_LISA-class • rgeodap_LISA — p_LISA-class • rgeoda - +
- +

p_LISA

- Source: R/rgeoda.R + Source: R/rgeoda.R
@@ -75,15 +75,15 @@

p_LISA

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/percentile_breaks.html b/reference/percentile_breaks.html index d6a62504..18fcd70e 100644 --- a/reference/percentile_breaks.html +++ b/reference/percentile_breaks.html @@ -1,10 +1,10 @@ -Percentile Breaks — percentile_breaks • rgeodaPercentile Breaks — percentile_breaks • rgeoda - +
- +

Percentile Breaks

- Source: R/utils.R + Source: R/utils.R
@@ -67,15 +67,15 @@

Percentile Breaks

Arguments

-
df
+ + +
df

A data frame with selected variable. E.g. guerry["Crm_prs"]

Value

- - -

A vector of numeric values of computed breaks

+

A vector of numeric values of computed breaks

@@ -107,15 +107,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/quantile_breaks.html b/reference/quantile_breaks.html index d7a0e330..e11cb47e 100644 --- a/reference/quantile_breaks.html +++ b/reference/quantile_breaks.html @@ -1,10 +1,10 @@ -Quantile Breaks — quantile_breaks • rgeodaQuantile Breaks — quantile_breaks • rgeoda - +
- +

Quantile Breaks

- Source: R/utils.R + Source: R/utils.R
@@ -67,19 +67,19 @@

Quantile Breaks

Arguments

-
k
+ + +
k

A numeric value indicates how many breaks

-
df
+
df

A data frame with selected variable. E.g. guerry["Crm_prs"]

Value

- - -

A vector of numeric values of computed breaks

+

A vector of numeric values of computed breaks

@@ -111,15 +111,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/queen_weights.html b/reference/queen_weights.html index f53f3c76..44c0bc69 100644 --- a/reference/queen_weights.html +++ b/reference/queen_weights.html @@ -1,10 +1,10 @@ -Queen Contiguity Spatial Weights — queen_weights • rgeoda - +
- +

Queen Contiguity Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,20 +72,22 @@

Queen Contiguity Spatial Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
order
+
order

(Optional) Order of contiguity

-
include_lower_order
+
include_lower_order

(Optional) Whether or not the lower order neighbors should be included in the weights structure

-
precision_threshold
+
precision_threshold

(Optional) The precision of the underlying shape file is insufficient to allow for an exact match of coordinates to determine which polygons are neighbors

@@ -93,9 +95,7 @@

Arguments

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -136,15 +136,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_gal.html b/reference/read_gal.html index 8da3a4f6..6843f9f0 100644 --- a/reference/read_gal.html +++ b/reference/read_gal.html @@ -1,9 +1,9 @@ -Read a .GAL file — read_gal • rgeodaRead a .GAL file — read_gal • rgeoda - +
- +

Read a .GAL file

- Source: R/weights.R + Source: R/weights.R
@@ -65,20 +65,20 @@

Read a .GAL file

Arguments

-
file_path
+ + +
file_path

The file paht of the .GAL file

-
id_vec
+
id_vec

The id_vec is the id values used in the .GAL file. Default is empty.

Value

- - -

A weights object

+

A weights object

@@ -93,15 +93,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_gwt.html b/reference/read_gwt.html index ba2c5162..458c0618 100644 --- a/reference/read_gwt.html +++ b/reference/read_gwt.html @@ -1,9 +1,9 @@ -Read a .GWT file — read_gwt • rgeodaRead a .GWT file — read_gwt • rgeoda - +
- +

Read a .GWT file

- Source: R/weights.R + Source: R/weights.R
@@ -65,20 +65,20 @@

Read a .GWT file

Arguments

-
file_path
+ + +
file_path

The file paht of the .GWT file

-
id_vec
+
id_vec

The id_vec is the id values used in the .GWT file. Default is empty.

Value

- - -

A weights object

+

A weights object

@@ -93,15 +93,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/read_swm.html b/reference/read_swm.html index a0fa7e01..e51c5537 100644 --- a/reference/read_swm.html +++ b/reference/read_swm.html @@ -1,9 +1,9 @@ -Read a .SWM file — read_swm • rgeodaRead a .SWM file — read_swm • rgeoda - +
- +

Read a .SWM file

- Source: R/weights.R + Source: R/weights.R
@@ -65,20 +65,20 @@

Read a .SWM file

Arguments

-
file_path
+ + +
file_path

The file paht of the .SWM file

-
id_vec
+
id_vec

The id_vec is the id values used in the .SWM file. e.g. c(0,1,2,3,...)

Value

- - -

A weights object

+

A weights object

@@ -93,15 +93,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/redcap.html b/reference/redcap.html index dcaeabd2..50a483a7 100644 --- a/reference/redcap.html +++ b/reference/redcap.html @@ -1,5 +1,5 @@ -Regionalization with dynamically constrained agglomerative clustering and partitioning — redcap • rgeodaRegionalization with dynamically constrained agglomerative clustering and partitioning — redcap • rgeoda - +
- +

Regionalization with dynamically constrained agglomerative clustering and partitioning

- Source: R/clustering.R + Source: R/clustering.R
@@ -99,60 +99,60 @@

Regionalization with dynamically constrained agglomerative clustering and pa

Arguments

-
k
+ + +
k

The number of clusters

-
w
+
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
method
+
method

"firstorder-singlelinkage", "fullorder-completelinkage", "fullorder-averagelinkage","fullorder-singlelinkage", "fullorder-wardlinkage"

-
bound_variable
+
bound_variable

(optional) A data frame with selected bound variabl

-
min_bound
+
min_bound

(optional) A minimum bound value that applies to all clusters

-
scale_method
+
scale_method

(optional) One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(int,optional) The seed for random number generator. Defaults to 123456789.

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel computation

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -160,7 +160,7 @@ 
Examples

 data <- guerry[c('Crm_prs','Crm_prp','Litercy','Donatns','Infants','Suicids')]
 guerry_clusters <- redcap(4, queen_w, data, "fullorder-completelinkage")
 guerry_clusters
-}
+} # }
@@ -175,15 +175,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/rook_weights.html b/reference/rook_weights.html index 7c01b07d..0152e47d 100644 --- a/reference/rook_weights.html +++ b/reference/rook_weights.html @@ -1,10 +1,10 @@ -Rook Contiguity Spatial Weights — rook_weights • rgeoda - +
- +

Rook Contiguity Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -72,20 +72,22 @@

Rook Contiguity Spatial Weights

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
order
+
order

(Optional) Order of contiguity

-
include_lower_order
+
include_lower_order

(Optional) Whether or not the lower order neighbors should be included in the weights structure

-
precision_threshold
+
precision_threshold

(Optional) The precision of the underlying shape file is insufficient to allow for an exact match of coordinates to determine which polygons are neighbors

@@ -93,9 +95,7 @@

Arguments

Value

- - -

An instance of Weight-class

+

An instance of Weight-class

@@ -136,15 +136,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/save_weights.html b/reference/save_weights.html index 664b162c..e1e25baf 100644 --- a/reference/save_weights.html +++ b/reference/save_weights.html @@ -1,9 +1,9 @@ -Save Spatial Weights — save_weights • rgeodaSave Spatial Weights — save_weights • rgeoda - +
- +

Save Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,39 +65,39 @@

Save Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

-
id_variable
+
id_variable

The id variable (a data.frame) that defines the unique value of each observation when saving a weights file

-
out_path
+
out_path

The path of an output weights file

-
layer_name
+
layer_name

(optional) The name of the layer of input dataset

Value

- - -

A boolean value indicates if save successfully or failed

+

A boolean value indicates if save successfully or failed

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 save_weights(quen_w, guerry_df['CODE_DE'], out_path = '/path/Guerry_r.gal')
-}
+} # }
@@ -112,15 +112,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/schc.html b/reference/schc.html index 32c5385e..5d00bb47 100644 --- a/reference/schc.html +++ b/reference/schc.html @@ -1,12 +1,12 @@ -Spatially Constrained Hierarchical Clucstering (SCHC) — schc • rgeodaSpatially Constrained Hierarchical Clucstering (SCHC) — schc • rgeoda - +
- +

Spatially Constrained Hierarchical Clucstering (SCHC)

- Source: R/clustering.R + Source: R/clustering.R
@@ -81,47 +81,47 @@

Spatially Constrained Hierarchical Clucstering (SCHC)

Arguments

-
k
+ + +
k

The number of clusters

-
w
+
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
method
+
method

"single", "complete", "average","ward"

-
bound_variable
+
bound_variable

(optional) A data frame with selected bound variabl

-
min_bound
+
min_bound

(optional) A minimum bound value that applies to all clusters

-
scale_method
+
scale_method

One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

+

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

@@ -172,15 +172,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/set_neighbors.html b/reference/set_neighbors.html index 944ad96a..6bf578f6 100644 --- a/reference/set_neighbors.html +++ b/reference/set_neighbors.html @@ -1,9 +1,9 @@ -Set neighbors of an observation — set_neighbors • rgeodaSet neighbors of an observation — set_neighbors • rgeoda - +
- +

Set neighbors of an observation

- Source: R/weights.R + Source: R/weights.R
@@ -65,15 +65,17 @@

Set neighbors of an observation

Arguments

-
gda_w
+ + +
gda_w

A Weight object

-
idx
+
idx

A value indicates idx-th observation, idx start from 1

-
nbrs
+
nbrs

A list indicates the neighbors of idx-th observation (id start from 1)

@@ -81,11 +83,11 @@

Arguments

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 new_w <- create_weights(10)
 set_neighbors(new_w, 1, c(2,3))
 update_weights(new_w)
-}
+} # }
@@ -100,15 +102,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/set_neighbors_with_weights.html b/reference/set_neighbors_with_weights.html index bba785a7..13c011a8 100644 --- a/reference/set_neighbors_with_weights.html +++ b/reference/set_neighbors_with_weights.html @@ -1,10 +1,10 @@ -Set neighbors and weights values of an observation — set_neighbors_with_weights • rgeodaSet neighbors and weights values of an observation — set_neighbors_with_weights • rgeoda - +
- +

Set neighbors and weights values of an observation

- Source: R/weights.R + Source: R/weights.R
@@ -67,31 +67,33 @@

Set neighbors and weights values of an observation

Arguments

-
gda_w
+ + +
gda_w

A Weight object

-
idx
+
idx

A value indicates idx-th observation, idx start from 1

-
nbrs
+
nbrs

A list indicates the neighbors of idx-th observation (id start from 1)

-
wvals
+
wvals

A list indicates the associated weights values of the neighbors

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 new_w <- create_weights(10)
 set_neighbors(new_w, 1, c(2,3))
 update_weights(new_w)
-}
+} # }
@@ -106,15 +108,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/sf_to_geoda.html b/reference/sf_to_geoda.html index 5705791c..3245955f 100644 --- a/reference/sf_to_geoda.html +++ b/reference/sf_to_geoda.html @@ -1,11 +1,11 @@ -Create an instance of geoda-class from a 'sf' object — sf_to_geoda • rgeodaCreate an instance of geoda-class from a 'sf' object — sf_to_geoda • rgeoda - +
- +

Create an instance of geoda-class from a 'sf' object

- Source: R/sf_geoda.R + Source: R/sf_geoda.R
@@ -69,20 +69,20 @@

Create an instance of geoda-class from a 'sf' object

Arguments

-
sf_obj
+ + +
sf_obj

An instance of 'sf' object

-
with_table
+
with_table

A boolean flag indicates if table is copied from sf object to create geoda object. Default is TRUE.

Value

- - -

An instance of geoda-class

+

An instance of geoda-class

@@ -97,15 +97,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/skater.html b/reference/skater.html index d1701422..b9165598 100644 --- a/reference/skater.html +++ b/reference/skater.html @@ -1,10 +1,10 @@ -Spatial C(K)luster Analysis by Tree Edge Removal — skater • rgeodaSpatial C(K)luster Analysis by Tree Edge Removal — skater • rgeoda - +
- +

Spatial C(K)luster Analysis by Tree Edge Removal

- Source: R/clustering.R + Source: R/clustering.R
@@ -78,60 +78,60 @@

Spatial C(K)luster Analysis by Tree Edge Removal

Arguments

-
k
+ + +
k

The number of clusters

-
w
+
w

An instance of Weight class

-
df
+
df

A data frame with selected variables only. E.g. guerry[c("Crm_prs", "Crm_prp", "Litercy")]

-
bound_variable
+
bound_variable

(optional) A data frame with selected bound variable

-
min_bound
+
min_bound

(optional) A minimum bound value that applies to all clusters

-
scale_method
+
scale_method

One of the scaling methods 'raw', 'standardize', 'demean', 'mad', 'range_standardize', 'range_adjust' to apply on input data. Default is 'standardize' (Z-score normalization).

-
distance_method
+
distance_method

(optional) The distance method used to compute the distance betwen observation i and j. Defaults to "euclidean". Options are "euclidean" and "manhattan"

-
random_seed
+
random_seed

(int,optional) The seed for random number generator. Defaults to 123456789.

-
cpu_threads
+
cpu_threads

(optional) The number of cpu threads used for parallel computation

-
rdist
+
rdist

(optional) The distance matrix (lower triangular matrix, column wise storage)

Value

- - -

A names list with names "Clusters", "Total sum of squares", +

A names list with names "Clusters", "Total sum of squares", "Within-cluster sum of squares", "Total within-cluster sum of squares", and "The ratio of between to total sum of squares".

@@ -184,15 +184,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/sp_to_geoda.html b/reference/sp_to_geoda.html index 80013a2f..5181fe56 100644 --- a/reference/sp_to_geoda.html +++ b/reference/sp_to_geoda.html @@ -1,10 +1,10 @@ -Create an instance of geoda-class from a 'sp' object — sp_to_geoda • rgeodaCreate an instance of geoda-class from a 'sp' object — sp_to_geoda • rgeoda - +
- +

Create an instance of geoda-class from a 'sp' object

- Source: R/sf_geoda.R + Source: R/sf_geoda.R
@@ -67,20 +67,20 @@

Create an instance of geoda-class from a 'sp' object

Arguments

-
sp_obj
+ + +
sp_obj

An instance of 'sp' object

-
with_table
+
with_table

A boolean flag indicates if table is copied from sf object to create geoda object. Default is TRUE

Value

- - -

An instance of geoda-class

+

An instance of geoda-class

@@ -95,15 +95,15 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/spatial_lag.html b/reference/spatial_lag.html index 092451d7..5fcc0095 100644 --- a/reference/spatial_lag.html +++ b/reference/spatial_lag.html @@ -1,10 +1,10 @@ -Spatial Lag — spatial_lag • rgeodaSpatial Lag — spatial_lag • rgeoda - +
- +

Spatial Lag

- Source: R/weights.R + Source: R/weights.R
@@ -67,31 +67,31 @@

Spatial Lag

Arguments

-
gda_w
+ + +
gda_w

A Weight object

-
df
+
df

A data frame with selected variable only. E.g. guerry["Crm_prs"]

Value

- - -

A data.frame with one column "Spatial Lag"

+

A data.frame with one column "Spatial Lag"

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 crm_lag <- spatial_lag(queen_w, guerry["Crm_prs"])
 crm_lag
-}
+} # }
@@ -106,15 +106,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/spatial_validation.html b/reference/spatial_validation.html index 74c0133e..c189e08f 100644 --- a/reference/spatial_validation.html +++ b/reference/spatial_validation.html @@ -1,11 +1,11 @@ -Spatial Validation — spatial_validation • rgeodaSpatial Validation — spatial_validation • rgeoda - +
- +

Spatial Validation

- Source: R/clustering.R + Source: R/clustering.R
@@ -69,29 +69,29 @@

Spatial Validation

Arguments

-
sf_obj
+ + +
sf_obj

An sf (simple feature) object

-
clusters
+
clusters

A cluster classification variable (categorical values from a dataframe or values returned from cluster functions)

-
w
+
w

An instance of Weight class

Value

- - -

A list with names "Is Spatially Constrained", "Fragmentation", "Join Count Ratio", +

A list with names "Is Spatially Constrained", "Fragmentation", "Join Count Ratio", "Compactness", and "Diameter".

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
@@ -100,7 +100,7 @@ 
Examples

 clusters <- skater(5, queen_w, data)
 results <- spatial_validation(guerry, clusters, queen_w)
 results
-}
+} # }
@@ -115,15 +115,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/stddev_breaks.html b/reference/stddev_breaks.html index fcd52455..5363bde7 100644 --- a/reference/stddev_breaks.html +++ b/reference/stddev_breaks.html @@ -1,11 +1,11 @@ -Standard Deviation Breaks — stddev_breaks • rgeodaStandard Deviation Breaks — stddev_breaks • rgeoda - +
- +

Standard Deviation Breaks

- Source: R/utils.R + Source: R/utils.R
@@ -69,15 +69,15 @@

Standard Deviation Breaks

Arguments

-
df
+ + +
df

A data frame with selected variable. E.g. guerry["Crm_prs"]

Value

- - -

A vector of numeric values of computed breaks

+

A vector of numeric values of computed breaks

@@ -109,15 +109,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/summary.Weight.html b/reference/summary.Weight.html index 09fb304e..edc6ca2e 100644 --- a/reference/summary.Weight.html +++ b/reference/summary.Weight.html @@ -1,9 +1,9 @@ -Summary of Spatial Weights — summary.Weight • rgeodaSummary of Spatial Weights — summary.Weight • rgeoda - +
- +

Summary of Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -60,36 +60,36 @@

Summary of Spatial Weights

- 
# S3 method for Weight
+    
# S3 method for class 'Weight'
 summary(object, ...)

Arguments

-
object
+ + +
object

A Weight object

-
...
+
...

summary optional parameters

Value

- - -

A summary description of an instance of Weight-class

+

A summary description of an instance of Weight-class

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 library(sf)
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 summary(queen_w)
-}
+} # }
@@ -104,15 +104,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/update_weights.html b/reference/update_weights.html index b1c69f36..a42059cd 100644 --- a/reference/update_weights.html +++ b/reference/update_weights.html @@ -1,10 +1,10 @@ -Update meta data of a spatial weights — update_weights • rgeodaUpdate meta data of a spatial weights — update_weights • rgeoda - +
- +

Update meta data of a spatial weights

- Source: R/weights.R + Source: R/weights.R
@@ -67,18 +67,20 @@

Update meta data of a spatial weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 new_w <- create_weights(10)
 set_neighbors(new_w, 1, c(2,3))
 update_weights(new_w)
-}
+} # }
@@ -93,15 +95,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/reference/weights_sparsity.html b/reference/weights_sparsity.html index e056ff56..ea85fa90 100644 --- a/reference/weights_sparsity.html +++ b/reference/weights_sparsity.html @@ -1,9 +1,9 @@ -Sparsity of Spatial Weights — weights_sparsity • rgeodaSparsity of Spatial Weights — weights_sparsity • rgeoda - +
- +

Sparsity of Spatial Weights

- Source: R/weights.R + Source: R/weights.R
@@ -65,25 +65,25 @@

Sparsity of Spatial Weights

Arguments

-
gda_w
+ + +
gda_w

A Weight object

Value

- - -

A numeric value of spatial weights sparsity

+

A numeric value of spatial weights sparsity

Examples

- 
if (FALSE) {
+    
if (FALSE) { # \dontrun{
 guerry_path <- system.file("extdata", "Guerry.shp", package = "rgeoda")
 guerry <- st_read(guerry_path)
 queen_w <- queen_weights(guerry)
 weights_sparsity(queen_w)
-}
+} # }
@@ -98,15 +98,15 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/sitemap.xml b/sitemap.xml index b7118708..06ca6538 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,279 +1,95 @@ - - - - /404.html - - - /articles/index.html - - - /articles/rgeoda_tutorial.html - - - /authors.html - - - /index.html - - - /reference/LISA-class.html - - - /reference/Weight-class.html - - - /reference/as.data.frame.geoda.html - - - /reference/as.geoda.html - - - /reference/as.matrix.Weight.html - - - /reference/azp_greedy.html - - - /reference/azp_sa.html - - - /reference/azp_tabu.html - - - /reference/create_weights.html - - - /reference/distance_weights.html - - - /reference/eb_rates.html - - - /reference/gda_distance_weights.html - - - /reference/gda_kernel_knn_weights.html - - - /reference/gda_kernel_weights.html - - - /reference/gda_knn_weights.html - - - /reference/gda_min_distthreshold.html - - - /reference/gda_queen_weights.html - - - /reference/gda_rook_weights.html - - - /reference/geoda-class.html - - - /reference/geoda_open.html - - - /reference/get_neighbors.html - - - /reference/get_neighbors_weights.html - - - /reference/has_isolates.html - - - /reference/hinge15_breaks.html - - - /reference/hinge30_breaks.html - - - /reference/index.html - - - /reference/is_symmetric.html - - - /reference/join_count_ratio.html - - - /reference/kernel_knn_weights.html - - - /reference/kernel_weights.html - - - /reference/knn_weights.html - - - /reference/lisa_bo.html - - - /reference/lisa_clusters.html - - - /reference/lisa_colors.html - - - /reference/lisa_fdr.html - - - /reference/lisa_labels.html - - - /reference/lisa_num_nbrs.html - - - /reference/lisa_pvalues.html - - - /reference/lisa_values.html - - - /reference/local_bijoincount.html - - - /reference/local_bimoran.html - - - /reference/local_g.html - - - /reference/local_geary.html - - - /reference/local_gstar.html - - - /reference/local_joincount.html - - - /reference/local_moran.html - - - /reference/local_moran_eb.html - - - /reference/local_multigeary.html - - - /reference/local_multijoincount.html - - - /reference/local_multiquantilelisa.html - - - /reference/local_quantilelisa.html - - - /reference/make_spatial.html - - - /reference/max_neighbors.html - - - /reference/maxp_greedy.html - - - /reference/maxp_sa.html - - - /reference/maxp_tabu.html - - - /reference/mean_neighbors.html - - - /reference/median_neighbors.html - - - /reference/min_distthreshold.html - - - /reference/min_neighbors.html - - - /reference/natural_breaks.html - - - /reference/neighbor_match_test.html - - - /reference/p_GeoDa-class.html - - - /reference/p_GeoDaTable-class.html - - - /reference/p_GeoDaWeight-class.html - - - /reference/p_LISA-class.html - - - /reference/percentile_breaks.html - - - /reference/quantile_breaks.html - - - /reference/queen_weights.html - - - /reference/read_gal.html - - - /reference/read_gwt.html - - - /reference/read_swm.html - - - /reference/redcap.html - - - /reference/rook_weights.html - - - /reference/save_weights.html - - - /reference/schc.html - - - /reference/set_neighbors.html - - - /reference/set_neighbors_with_weights.html - - - /reference/sf_to_geoda.html - - - /reference/skater.html - - - /reference/sp_to_geoda.html - - - /reference/spatial_lag.html - - - /reference/spatial_validation.html - - - /reference/stddev_breaks.html - - - /reference/summary.Weight.html - - - /reference/update_weights.html - - - /reference/weights_sparsity.html - + +/404.html +/articles/index.html +/articles/rgeoda_tutorial.html +/authors.html +/index.html +/reference/LISA-class.html +/reference/Weight-class.html +/reference/as.data.frame.geoda.html +/reference/as.geoda.html +/reference/as.matrix.Weight.html +/reference/azp_greedy.html +/reference/azp_sa.html +/reference/azp_tabu.html +/reference/create_weights.html +/reference/distance_weights.html +/reference/eb_rates.html +/reference/gda_distance_weights.html +/reference/gda_kernel_knn_weights.html +/reference/gda_kernel_weights.html +/reference/gda_knn_weights.html +/reference/gda_min_distthreshold.html +/reference/gda_queen_weights.html +/reference/gda_rook_weights.html +/reference/geoda-class.html +/reference/geoda_open.html +/reference/get_neighbors.html +/reference/get_neighbors_weights.html +/reference/has_isolates.html +/reference/hinge15_breaks.html +/reference/hinge30_breaks.html +/reference/index.html +/reference/is_symmetric.html +/reference/join_count_ratio.html +/reference/kernel_knn_weights.html +/reference/kernel_weights.html +/reference/knn_weights.html +/reference/lisa_bo.html +/reference/lisa_clusters.html +/reference/lisa_colors.html +/reference/lisa_fdr.html +/reference/lisa_labels.html +/reference/lisa_num_nbrs.html +/reference/lisa_pvalues.html +/reference/lisa_values.html +/reference/local_bijoincount.html +/reference/local_bimoran.html +/reference/local_g.html +/reference/local_geary.html +/reference/local_gstar.html +/reference/local_joincount.html +/reference/local_moran.html +/reference/local_moran_eb.html +/reference/local_multigeary.html +/reference/local_multijoincount.html +/reference/local_multiquantilelisa.html +/reference/local_quantilelisa.html +/reference/make_spatial.html +/reference/max_neighbors.html +/reference/maxp_greedy.html +/reference/maxp_sa.html +/reference/maxp_tabu.html +/reference/mean_neighbors.html +/reference/median_neighbors.html +/reference/min_distthreshold.html +/reference/min_neighbors.html +/reference/natural_breaks.html +/reference/neighbor_match_test.html +/reference/p_GeoDa-class.html +/reference/p_GeoDaTable-class.html +/reference/p_GeoDaWeight-class.html +/reference/p_LISA-class.html +/reference/percentile_breaks.html +/reference/quantile_breaks.html +/reference/queen_weights.html +/reference/read_gal.html +/reference/read_gwt.html +/reference/read_swm.html +/reference/redcap.html +/reference/rook_weights.html +/reference/save_weights.html +/reference/schc.html +/reference/set_neighbors.html +/reference/set_neighbors_with_weights.html +/reference/sf_to_geoda.html +/reference/skater.html +/reference/sp_to_geoda.html +/reference/spatial_lag.html +/reference/spatial_validation.html +/reference/stddev_breaks.html +/reference/summary.Weight.html +/reference/update_weights.html +/reference/weights_sparsity.html +