Skip to content

Commit

Permalink
misc document fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
richardli committed Oct 25, 2023
1 parent e00a4ec commit db2156a
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 17 deletions.
7 changes: 4 additions & 3 deletions R/smoothArea.R
Original file line number Diff line number Diff line change
Expand Up @@ -391,8 +391,8 @@ plot.svysae <- function(x, return_list = F, plot.factor = NULL, ...) {
}
}

#' Plot heatmap comparing pairwise posterior exceedence probabilities for all
#' areas
#' Plot heatmap comparing pairwise posterior exceedence probabilities for svysae object
#'
#'
#' @param x svysae object. Plots are created for all models in this object.
#' @param posterior.sample Matrix of posteriors samples of area level quantities with one row for each area and one column for each sample. This argument may be specified to only provide a heatmap for the desired samples.
Expand All @@ -405,6 +405,7 @@ plot.svysae <- function(x, return_list = F, plot.factor = NULL, ...) {
#' \dontrun{
#' data(DemoData2)
#' data(DemoMap2)
#' library(survey)
#' des0 <- svydesign(ids = ~clustid+id, strata = ~strata,
#' weights = ~weights, data = DemoData2, nest = T)
#' Xmat <- aggregate(age~region, data = DemoData2, FUN = mean)
Expand Down Expand Up @@ -500,7 +501,7 @@ compareEstimates <- function(x,
suppressWarnings(print(g_heat))
}
}
#' Title
#' Mapping estimates for svysae object
#'
#'
#' @param x syvsae object
Expand Down
5 changes: 3 additions & 2 deletions R/smoothUnit.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,16 @@
#' \dontrun{
#' data(DemoData2)
#' data(DemoMap2)
#' library(survey)
#' des0 <- svydesign(ids = ~clustid+id, strata = ~strata,
#' weights = ~weights, data = DemoData2, nest = T)
#'
#' EXAMPLE 1: Continuous response model
#' # EXAMPLE 1: Continuous response model
#' cts.res <- smoothUnit(formula = tobacco.use ~ 1,
#' domain = ~region,
#' design = des0, X.pop = DemoData2)
#'
#' EXAMPLE 2: Binary response model
#' # EXAMPLE 2: Binary response model
#' bin.res <- smoothUnit(formula = tobacco.use ~ 1,
#' family = "binomial",
#' domain = ~region,
Expand Down
7 changes: 3 additions & 4 deletions man/compareEstimates.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/mapEstimates.Rd

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

9 changes: 5 additions & 4 deletions man/smoothArea.Rd

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

5 changes: 3 additions & 2 deletions man/smoothUnit.Rd

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

0 comments on commit db2156a

Please sign in to comment.