Skip to content

Commit

Permalink
update rid document
Browse files Browse the repository at this point in the history
  • Loading branch information
SpatLyu committed Sep 24, 2024
1 parent aa5d4b3 commit 8f50d43
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
6 changes: 3 additions & 3 deletions R/rid.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
#' A case of road life expectancy analysis. Spatial Statistics, 59(100814), 100814.
#' https://doi.org/10.1016/j.spasta.2024.100814
#' @note
#' For bivariate spatial interactions, use the `RGD` function and specify the `type` parameter as `interaction`.
#'
#' The RID model requires at least \eqn{2^n-1} calculations when has \eqn{n} explanatory variables.
#' When there are more than 10 explanatory variables, carefully consider the computational burden of this model.
Expand Down Expand Up @@ -39,8 +38,9 @@
#' \dontrun{
#' ## The following code needs to configure the Python environment to run:
#' data('sim')
#' g = rid(y ~ ., data = sim %>% dplyr::select(-dplyr::any_of(c('lo','la'))),
#' discvar = c("xa","xb","xc"), discnum = 4, cores = 6)
#' g = rid(y ~ .,
#' data = dplyr::select(sim,-dplyr::any_of(c('lo','la'))),
#' discnum = 4, cores = 6)
#' g
#' }
rid = \(formula, data, discvar = NULL, discnum = 10,
Expand Down
7 changes: 3 additions & 4 deletions man/rid.Rd

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

0 comments on commit 8f50d43

Please sign in to comment.