Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add pkgdown function reference page #925

Merged
merged 6 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,5 @@ Config/testthat/edition: 3
Config/Needs/website: dplyr, geojsonio, ncdf4, tidyverse/tidytemplate
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Roxygen: list(markdown = TRUE)
4 changes: 4 additions & 0 deletions R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#' @format A data frame containing `City`, `State`, `Lat`,
#' `Long`, and population estimates from 2000 to 2010 (columns
#' `Pop2000` to `Pop2010`).
#' @family built in datasets
#' @source The US Census Bureau:
#' <https://www.census.gov/data/datasets/time-series/demo/popest/intercensal-2000-2010-cities-and-towns.html>
#' @noRd
Expand All @@ -32,6 +33,7 @@ if (file.exists("inst/csv/uspop2000.csv")) {
#' @details This dataset contains storm tracks for selected storms
#' in the Atlantic Ocean basin for the year 2005
#' @format `sp::SpatialLinesDataFrame`
#' @family built in datasets
NULL

#' @docType data
Expand All @@ -41,6 +43,7 @@ NULL
#' @details This dataset comes from <https://gadm.org>.
#' It was downloaded using [getData()].
#' @format `sp::SpatialPolygonsDataFrame`
#' @family built in datasets
#' @source
#' <https://gadm.org>
NULL
Expand All @@ -55,4 +58,5 @@ NULL
#' University of Marburg for a seminar called
#' "The Geography of Beer, sustainability in the food industry"
#' @format `sp::SpatialPointsDataFrame`
#' @family built in datasets
NULL
1 change: 1 addition & 0 deletions R/legacy.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#' @param session,outputId Deprecated
#'
#' @rdname deprecated
#' @keywords internal
#' @export
createLeafletMap <- function(session, outputId) {

Expand Down
6 changes: 6 additions & 0 deletions man/atlStorms2005.Rd

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

6 changes: 6 additions & 0 deletions man/breweries91.Rd

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

1 change: 1 addition & 0 deletions man/deprecated.Rd

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

6 changes: 6 additions & 0 deletions man/gadmCHE.Rd

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

85 changes: 85 additions & 0 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,88 @@ redirects:
- ["shiny.html", "articles/shiny.html"]
- ["showhide.html", "articles/showhide.html"]
- ["map_widget.html", "articles/widget.html"]

reference:
- title: The Map Widget
desc: The map widget and methods to manipulate it
contents:
- leaflet
- setView
- mapOptions
- leafletSizingPolicy

- title: Graphics Elements
desc: Adding and removing graphics
contents:
- addTiles
- tileOptions
- addProviderTiles
- providers
- addLegend
- addRasterImage
- addRasterLegend

- title: Layers & Groups
desc: Control groups and switch layers on and off
contents:
- addMapPane
- addLayersControl
- showGroup
- groupOptions

- title: Colors
desc: Map variables to colors
contents:
- colorFactor
- previewColors

- title: Icons
desc: Use icons in `leaflet::addMarkers()`
contents:
- icons
- makeIcon
- iconList

- title: Add-ons
desc: Utility functions to add additional functionality to a `{leaflet}` map
- subtitle: Awesome Markers
contents:
- addAwesomeMarkers
- awesomeIcons
- makeAwesomeIcon
- awesomeIconList
- subtitle: Other
contents:
- addMeasure
- addScaleBar
- addGraticule
- addSimpleGraticule
- addTerminator
- addMiniMap
- addEasyButton
- addEasyButtonBar

- title: Shiny
desc: Using leaflet in `{shiny}`
contents:
- leafletOutput
- leafletProxy
- removeControl

- title: Extending Leaflet
desc: Functions for extending leaflet
contents:
- derivePoints
- evalFormula
- expandLimits
- expandLimitsBbox
- filterNULL
- getMapData
- invokeMethod
- validateCoords
- leafletDependencies

- title: Built in datasets
desc: Spatial datasets exported by `{leaflet}`
contents:
- has_concept("built in datasets")
Loading