R/choropleth_GnmNum.R

In randommonkey/lfltmagic: A wrapper for highcharter

#' choropleth chart Gnm Num
#'
#' @description
#' `lflt_choropleth_GnmNum()` Create a Leaflet choropleth map based on a particular data type.
#' In this case, you can load data with only two columns, where the firts it's a **geoname column**,
#' and the second is a **numeric class column**, or make sure that the first two columns of
#' your data meet this condition
#'
#' @export
#' @family Gnm-Num plots
#' @section Ftype:
#' Gnm-Num
#' @examples
#' data <- sample_data("Gnm-Num", n = 30)
#' lflt_choropleth_GnmNum(data)
#'
#'
#' # if you want to calculate the average instead of the sum, you can use agg inside a function
#' lflt_choropleth_GnmNum(data,
#'                        agg = "mean")
#'
#'
lflt_choropleth_GnmNum <- function(data = NULL, ...) {

  opts <- dsvizopts::merge_dsviz_options(...)
  if (!is.null(data)) {
    l <- lfltmagic_prep(data = NULL, opts = opts, ftype="Gnm-Num")
    data[[1]] <- homodatum::as_Gnm(data[[1]])
    if (l$more_levels) {
      data[[3]] <- homodatum::as_Num(data[[3]])
    } else {
      data[[2]] <- homodatum::as_Num(data[[2]])
    }
  }

  l <- lfltmagic_prep(data = data, opts = opts, ftype="Gnm-Num")

  lf <- lflt_basic_choropleth(l) %>%
          lflt_background(l$theme) %>%
              lflt_graticule(l$graticule) %>%
               lflt_titles(l$titles)

  lf
}



#' choropleth chart Gnm
#'
#' @description
#' `lflt_choropleth_Gnm()` Create a Leaflet choropleth map based on a particular data type.
#' In this case, you can load data with only one column, where it's a **geoname column**,
#' or make sure that the first column of your data meet this condition
#'
#' @export
#' @inheritParams lflt_choropleth_GnmNum
#' @section Ftype:
#' Gnm
#' @examples
#' data <- sample_data("Gnm", n = 30)
#' lflt_choropleth_Gnm(data)
#'
#' # Activate data labels
#' lflt_choropleth_Gnm(data)
#'
#' # if you want to calculate the average instead of the sum, you can use agg inside a function
#' lflt_choropleth_Gnm(data,
#'                        agg = "mean")
#'
lflt_choropleth_Gnm <- function(data = NULL, ...) {

  opts <- dsvizopts::merge_dsviz_options(...)
  if (!is.null(data)) data[[1]] <- homodatum::as_Gnm(data[[1]])
  l <- lfltmagic_prep(data = data, opts = opts, ftype="Gnm")

  lf <- lflt_basic_choropleth(l) %>%
    lflt_background(l$theme) %>%
    lflt_graticule(l$graticule) %>%
    lflt_titles(l$titles)

  lf
}