init

R/protomapr-package.R

@@ -0,0 +1,44 @@
+#' protomapr: Add Protomaps Layers to Leaflet Maps
+#'
+#' The protomapr package provides functions to add Protomaps vector tile
+#' layers to leaflet maps in R. Unlike raster tile providers, Protomaps
+#' offers full customization of colors and features, self-hosting from a
+#' single PMTiles file, and smooth vector rendering at any zoom level.
+#' See \code{vignette("getting-started")} for why you might choose Protomaps
+#' over standard provider tiles.
+#'
+#' @section Main Functions:
+#' \describe{
+#'   \item{\code{\link{addProtomaps}}}{Add a Protomaps layer to a Leaflet map}
+#'   \item{\code{\link{protomapsOptions}}}{Configure additional layer options}
+#' }
+#'
+#' @section Symbolizers:
+#' \describe{
+#'   \item{\code{\link{pmPolygonSymbolizer}}}{Style polygon features}
+#'   \item{\code{\link{pmLineSymbolizer}}}{Style line features}
+#'   \item{\code{\link{pmCircleSymbolizer}}}{Style point features as circles}
+#'   \item{\code{\link{pmTextSymbolizer}}}{Add text labels}
+#'   \item{\code{\link{pmCenteredTextSymbolizer}}}{Add centered text labels}
+#'   \item{\code{\link{pmLineLabelSymbolizer}}}{Add labels along lines}
+#'   \item{\code{\link{pmShieldSymbolizer}}}{Add shield/badge labels}
+#' }
+#'
+#' @section Rules:
+#' \describe{
+#'   \item{\code{\link{pmPaintRule}}}{Define how to paint features}
+#'   \item{\code{\link{pmLabelRule}}}{Define how to label features}
+#' }
+#'
+#' @section Available Themes:
+#' The following built-in themes are available:
+#' \itemize{
+#'   \item \code{"light"} - General-purpose light basemap
+#'   \item \code{"dark"} - General-purpose dark basemap
+#'   \item \code{"white"} - High-contrast white theme for data visualization
+#'   \item \code{"grayscale"} - Monochromatic theme
+#'   \item \code{"black"} - Dark theme for data visualization
+#' }
+#'
+#' @keywords internal
+"_PACKAGE"