webmap

Description

The R package webmap creates interactive web maps using the JavaScript Leaflet library with base layers of The National Map (TNM). Map service endpoints are offered with no use restrictions and provide access to base geospatial information that describes the landscape of the United States and its territories. Base layers outside these areas are unavailable at higher spatial scales. This package is dependent on, and intended to be used with, the Leaflet for R package. Various utility functions are included that allow you to augment your web map with additional elements.

Installation

The current release is available on CRAN, which you can install by running this command in your R console:

install.packages("webmap")

To install the development version, you need to clone the repository and build from source, or run:

if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_gitlab(
  repo = "inl/webmap@develop",
  auth_token = Sys.getenv("GITLAB_PAT"),
  host = "code.usgs.gov",
  dependencies = TRUE
)

Once installed, you can use this package at the R console, within R Markdown documents, and within Shiny applications.

Basic Usage

You can create the default web map and display it (a screenshot is shown below) by running these commands:

library("webmap")
map <- make_map()
map

Additional examples are provided in the package help pages. To access these documents, run:

help(package = "webmap")

Authors

• Jason C. Fisher (ORCID iD 0000-0001-9032-8912)
• Stefano Cudini (leaflet-search library)
• John Firebaugh (Leaflet.fullscreen library)

Point of Contact

Jason C. Fisher (jfisher@usgs.gov)

Suggested Citation

To cite webmap in publications, please use:

Fisher, J.C., 2023, webmap—Interactive web maps using The National Map (TNM) services: U.S. Geological Survey software release, R package, Reston, Va., https://doi.org/10.5066/P9CPB1WD.

Contributing

We welcome your contributions and suggestions for how to make these materials more useful to the community. Please feel free to comment on the issue tracker or open a merge request to contribute.

Code of Conduct

All contributions to- and interactions surrounding- this project will abide by the USGS Code of Scientific Conduct.

Disclaimer

This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software.

Any use of trade, product, or firm names is for descriptive purposes only and does not imply endorsement by the U.S. Government.

MIT License

Copyright (c) 2023, webmap authors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Support

The Idaho National Laboratory Project Office of the USGS supports the development and maintenance of webmap. Resources are available primarily for maintenance and responding to user questions. Priorities on the development of new features are determined by the development team.

Additional Publication Details

Additional metadata about this publication, not found in other parts of the page is in this table.