tidy readme

Makefile

@@ -53,7 +53,7 @@ clean:
 	rm -f -r $(PKGNAME).Rcheck/
 .PHONY: clean
 
-readme: install
+readme:
 	R -q -e 'rmarkdown::render('\''README.Rmd'\'')'
 .PHONY: readme
 
@@ -61,5 +61,5 @@ website: install
 	R -q -e 'pkgdown::build_site(examples = FALSE)'
 .PHONY: website
 
-everything: datasets readme check website lockfile clean
+everything: datasets readme install check website lockfile clean
 .PHONY: everything

R/make_map.R

@@ -129,7 +129,7 @@ make_map <- function(maps,
     }
   }
   checkmate::assert_character(maps, any.missing = FALSE, min.len = 1)
-  maps <- match.arg(maps, names(basemaps), several.ok = TRUE)
+  maps <- match.arg(maps, choices = names(basemaps), several.ok = TRUE)
   basemaps <- basemaps[maps]
 
   # subset TNM base maps

README.Rmd

@@ -78,7 +78,7 @@ Jason C. Fisher (<jfisher@usgs.gov>)
 To cite **webmap** in publications, please use:
 
 ```{r "citation", echo=FALSE, results="asis"}
-utils::citation(package = "webmap") |> print(style = "textVersion")
+utils::readCitationFile("inst/CITATION") |> print(style = "textVersion")
 ```
 
 ## Contributing
@@ -104,7 +104,7 @@ The Idaho National Laboratory Project Office of the USGS supports the developmen
 Additional metadata about this publication, not found in other parts of the page is in this table.
 
 ```{r "details", echo=FALSE, results="asis"}
-cite <- utils::citation(package = "webmap")
+cite <- utils::readCitationFile("inst/CITATION")
 x <- c(
   "Publication type" = "Formal R language package",
   "DOI" = cite[[1]]$doi,

README.md

-webmap <img src="man/figures/logo.svg" alt="webmap" align="right" width="152px" />
-==================================================================================
+# webmap <img src="man/figures/logo.svg" alt="webmap" align="right" width="152px" />
 
 [![cran-version-image](https://www.r-pkg.org/badges/version/webmap)](https://CRAN.R-project.org/package=webmap)
 [![pipeline-status-image](https://code.usgs.gov/inl/webmap/badges/main/pipeline.svg)](https://code.usgs.gov/inl/webmap/-/commits/main)
 [![coverage-report-image](https://code.usgs.gov/inl/webmap/badges/main/coverage.svg)](https://code.usgs.gov/inl/webmap/-/commits/main)
 
-Description
------------
+## Description
 
 The **webmap** package in [R](https://www.r-project.org/) is a tool that
 leverages the JavaScript [Leaflet](https://leafletjs.com/) library to
@@ -24,8 +22,7 @@ with the [Leaflet for R](https://rstudio.github.io/leaflet/) package.
 Furthermore, it comes equipped with a variety of utility functions that
 enable you to enhance your web map with additional features.
 
-Installation
-------------
+## Installation
 
 To install the current release of the package from
 [CRAN](https://CRAN.R-project.org/package=webmap) you can use the
@@ -59,8 +56,7 @@ After installing the package, you can use it in various contexts,
 including the R console, [R Markdown](https://rmarkdown.rstudio.com/)
 documents, and [Shiny](https://shiny.posit.co/) applications.
 
-Basic Usage
------------
+## Basic Usage
 
 To create the default web map and display it (the screenshot below
 showns the default web map), you can run the following commands:
@@ -82,8 +78,7 @@ these documents, run:
 help(package = "webmap")
 ```
 
-Authors
--------
+## Authors
 
 -   Jason C. Fisher (ORCID iD
     [0000-0001-9032-8912](https://orcid.org/0000-0001-9032-8912))
@@ -92,24 +87,19 @@ Authors
 -   John Firebaugh ([Leaflet.fullscreen
     library](https://github.com/Leaflet/Leaflet.fullscreen))
 
-Point of Contact
-----------------
+## Point of Contact
 
-Jason C. Fisher
-(<a href="mailto:jfisher@usgs.gov" class="email">jfisher@usgs.gov</a>)
+Jason C. Fisher (<jfisher@usgs.gov>)
 
-Suggested Citation
-------------------
+## 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.,
-<a href="https://doi.org/10.5066/P9CPB1WD" class="uri">https://doi.org/10.5066/P9CPB1WD</a>.
+Reston, Va., <https://doi.org/10.5066/P9CPB1WD>.
 
-Contributing
-------------
+## Contributing
 
 We value your contributions and suggestions on how to make these
 materials more useful to the community. Please feel free to share your
@@ -118,8 +108,7 @@ tracker](https://code.usgs.gov/inl/webmap/-/issues) or opening a [merge
 request](https://code.usgs.gov/inl/webmap/-/merge_requests) to
 contribute.
 
-Code of Conduct
----------------
+## Code of Conduct
 
 All contributions to- and interactions surrounding- this project will
 abide by the [USGS Code of Scientific
@@ -127,8 +116,7 @@ Conduct](https://www.usgs.gov/office-of-science-quality-and-integrity/fundamenta
 
 <!-- Embedded References -->
 
-Disclaimer
-----------
+## 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
@@ -143,8 +131,7 @@ 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
------------
+## MIT License
 
 Copyright (c) 2023, webmap authors
 
@@ -167,8 +154,7 @@ 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
--------
+## Support
 
 The Idaho National Laboratory Project Office of the USGS supports the
 development and maintenance of **webmap**. Resources are available
@@ -176,8 +162,7 @@ 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 Publication Details
 
 Additional metadata about this publication, not found in other parts of
 the page is in this table.