Skip to content

Commit

Permalink
fix: change alphastats to spatgeom in manual
Browse files Browse the repository at this point in the history
  • Loading branch information
maikol-solis committed Feb 14, 2023
1 parent 4224632 commit 80ed36f
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Imports:
lwgeom,
cowplot,
purrr
RoxygenNote: 7.2.0
RoxygenNote: 7.2.2
Roxygen: list(markdown=TRUE)
Depends: R (>= 3.6.0)
Suggests:
Expand Down
2 changes: 1 addition & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Generated by roxygen2: do not edit by hand

S3method(print,spatgeom)
export(alphastats)
export(plot_alpha_shape)
export(plot_curve)
export(spatgeom)
6 changes: 3 additions & 3 deletions R/plot_curves.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
#' @param x an object of class \code{spatgeom}
#' @param type a string that could be \code{curve} or \code{deriv}. The option
#' \code{curve} plots the curve of \code{alpha} against \code{geom_corr} from
#' the function [`spatgeom::alphastats()`]. The \code{deriv} option plots the
#' the function [`spatgeom::spatgeom()`]. The \code{deriv} option plots the
#' numerical derivative.
#' @param font_size a integer that increases the font size in the plot.
#'
#' @return a \code{\link[ggplot2]{ggplot}} object with the geometric indices (or
#' its derivative). The plot is generated with the \code{nalphas} point of
#' \code{alpha} and \code{geom_corr} from the function
#' \code{\link{alphastats}}.
#' \code{\link{spatgeom}}.
#'
#' In each panel, the theoretical CSR process is drawn using
#' \code{exp(-intensity * pi * x^2)}. where the intensity depends on each
Expand All @@ -29,7 +29,7 @@
#' Y <- data.frame(Y = r * sin(theta))
#' X <- data.frame(X1, X2)
#'
#' estimation <- alphastats(y = Y, x = X)
#' estimation <- spatgeom(y = Y, x = X)
#'
#' plot_curve(estimation, type = "curve")
#'
Expand Down
2 changes: 1 addition & 1 deletion R/plot_spatgeom.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#' Y <- data.frame(Y = r * sin(theta))
#' X <- data.frame(X1, X2)
#'
#' estimation <- alphastats(y = Y, x = X)
#' estimation <- spatgeom(y = Y, x = X)
#'
#' plot_alpha_shape(estimation, alpha = c(0.9, 1.2))
#' @export
Expand Down
4 changes: 2 additions & 2 deletions R/print.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#' \code{FALSE}
#' @param ... further arguments passed to the \code{plot} function
#'
#' @return Print the estimate given by \code{\link{alphastats}}.
#' @return Print the estimate given by \code{\link{spatgeom}}.
#' @export
#'
#' @examples
Expand All @@ -22,7 +22,7 @@
#' Y <- data.frame(Y = r * sin(theta))
#' X <- data.frame(X1, X2)
#'
#' estimation <- alphastats(y = Y, x = X)
#' estimation <- spatgeom(y = Y, x = X)
#'
#' print(estimation)
#'
Expand Down
2 changes: 1 addition & 1 deletion R/spatgeom.R
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
#' Y <- data.frame(Y = r * sin(theta))
#' X <- data.frame(X1, X2)
#'
#' estimation <- alphastats(y = Y, x = X)
#' estimation <- spatgeom(y = Y, x = X)
#' @export


Expand Down
4 changes: 2 additions & 2 deletions man/plot_alpha_shape.Rd

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

8 changes: 4 additions & 4 deletions man/plot_curve.Rd

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

4 changes: 2 additions & 2 deletions man/print.spatgeom.Rd

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

10 changes: 5 additions & 5 deletions man/alphastats.Rd → man/spatgeom.Rd

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

0 comments on commit 80ed36f

Please sign in to comment.