Skip to content

Commit

Permalink
update geoc*_* document
Browse files Browse the repository at this point in the history
  • Loading branch information
SpatLyu committed Sep 25, 2024
1 parent 68b25ba commit f1db93e
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions R/geocd_raster.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@
#' Default is `TRUE`.
#' @param method (optional) In instances where the method is `moran`, geocomplexity is
#' determined using local moran measure method. Conversely, when the method is `spvar`,
#' the spatial variance of local attribute data serves to characterize geocomplexity. For all
#' the spatial variance of attribute data serves to characterize geocomplexity. For all
#' other methods, the shannon information entropy of attribute data is employed to represent
#' geocomplexity. The selection of the method can be made from any one of the three options:
#' `moran`, `spvar` or `entropy`. Default is `moran`.
#'
#' @return A SpatRaster object
#' @return A `SpatRaster` object
#' @export
#'
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/geocd_vector.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#' @param returnsf (optional) When `returnsf` is `TRUE`, return an sf object, otherwise a tibble.
#' Default is `TRUE`.
#'
#' @return A tibble (`returnsf` is `FALSE`) or an sf object (`returnsf` is `TRUE`)
#' @return A `tibble` (`returnsf` is `FALSE`) or an `sf` object (`returnsf` is `TRUE`)
#' @export
#'
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/geocs_raster.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
#' represented using spatial variance, otherwise shannon information entropy is used. Default
#' is `spvar`.
#'
#' @return A SpatRaster object
#' @return A `SpatRaster` object
#' @export
#'
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/geocs_vector.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' @param returnsf (optional) When `returnsf` is `TRUE`, return an sf object, otherwise a tibble.
#' Default is `TRUE`.
#'
#' @return A tibble (`returnsf` is `FALSE`) or an sf object (`returnsf` is `TRUE`)
#' @return A `tibble` (`returnsf` is `FALSE`) or an `sf` object (`returnsf` is `TRUE`)
#' @export
#'
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion man/geocd_raster.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/geocd_vector.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/geocs_raster.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/geocs_vector.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f1db93e

Please sign in to comment.