Skip to content
Snippets Groups Projects
Commit 71f32a5a authored by Fisher, Jason C.'s avatar Fisher, Jason C.
Browse files

update readme

parent 0f39d1ea
No related branches found
No related tags found
2 merge requests!9Merge in develop and bump version,!6Edit readme and news
......@@ -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)
......
......@@ -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>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment