From 71f32a5a8ebcbb1789befdc762808f85fdfe2b01 Mon Sep 17 00:00:00 2001
From: Jason Fisher <jfisher@usgs.gov>
Date: Thu, 16 Jan 2025 10:42:41 -0800
Subject: [PATCH] update readme
---
README.Rmd | 9 ++++++---
README.md | 4 ++--
2 files changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.Rmd b/README.Rmd
index 9f5bc07..0013d4b 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -40,7 +40,7 @@ remotes::install_gitlab(
After installing the package, you can use it in various contexts, including the R console, [R Markdown] documents, and [Shiny] applications.
-## Basic Usage
+## Usage
To create the default web map and display it (the screenshot below showns the default web map),
you can run the following commands:
@@ -75,7 +75,8 @@ Jason C. Fisher (<jfisher@usgs.gov>)
To cite **webmap** in publications, please use:
```{r "citation", echo=FALSE, results="asis"}
-utils::readCitationFile("inst/CITATION") |> print(style = "textVersion")
+utils::readCitationFile("inst/CITATION") |>
+ print(style = "textVersion")
```
## Contributing
@@ -102,11 +103,13 @@ Additional metadata about this publication, not found in other parts of the page
```{r "details", echo=FALSE, results="asis"}
cite <- utils::readCitationFile("inst/CITATION")
+href <- sprintf("https://code.usgs.gov/inl/mlms/-/tree/v%s", cite[[1]]$version)
+version <- sprintf("<a href='%s'>%s</a>", href, cite[[1]]$version)
x <- c(
"Publication type" = "Formal R language package",
"DOI" = cite[[1]]$doi,
"Year published" = cite[[1]]$year,
- "Version" = cite[[1]]$version,
+ "Version" = version,
"IPDS" = "IP-155090"
)
x <- sprintf(" <tr><th scope='row'>%s</th><td>%s</td></tr>", names(x), x)
diff --git a/README.md b/README.md
index 8170ed3..4d42c8c 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,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
+## Usage
To create the default web map and display it (the screenshot below
showns the default web map), you can run the following commands:
@@ -198,7 +198,7 @@ Year published
Version
</th>
<td>
-1.0.0
+<a href='https://code.usgs.gov/inl/mlms/-/tree/v1.0.0'>1.0.0</a>
</td>
</tr>
<tr>
--
GitLab