From 37929ff3abfe47fa4537260277f6d725cf0c279c Mon Sep 17 00:00:00 2001
From: "Fisher, Jason C." <jfisher@usgs.gov>
Date: Wed, 11 Dec 2024 18:39:52 +0000
Subject: [PATCH] Remove duplicated package in DESCRIPTION file
---
DESCRIPTION | 5 +---
NEWS.md | 4 ++--
README.Rmd | 32 ++++++++++++++++++++-----
README.md | 67 +++++++++++++++++++++++++++++++++++------------------
4 files changed, 74 insertions(+), 34 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 78eaf2b..dcfcaec 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -33,12 +33,9 @@ Suggests:
jsonlite,
kableExtra,
knitr,
- pkgbuild,
- pkgdown,
- pkgdown,
- png,
magick,
markdown,
+ png,
pkgbuild,
pkgdown,
pkgload,
diff --git a/NEWS.md b/NEWS.md
index 1ff9dcf..e26c336 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,6 +1,6 @@
-# inlpubs (development version)
+# inlpubs 1.2.0
-- ...
+- Integrate the remaining publications for 2024.
# inlpubs 1.1.3
diff --git a/README.Rmd b/README.Rmd
index 2ccba05..8dbd6fe 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -23,9 +23,16 @@ nauthor <- nrow(authors)
## Description
-The [R] package **inlpubs** may be used to search and analyze the `r npubs` publications that cover the `r nyears`-year history of the U.S. Geological Survey ([USGS]), Idaho Water Science Center, Idaho National Laboratory Project Office ([INLPO]). The INLPO publications were authored by `r nauthor` researchers trying to better understand the effects of waste disposal on water contained in the eastern Snake River Plain aquifer and the availability of water for long-term consumptive and industrial use. Information contained within these publications is crucial to the management and use of the aquifer by the Idaho National Laboratory ([INL]) and the State of Idaho. USGS geohydrologic studies and monitoring, which began in 1920, were done in cooperation with the U.S. Department of Energy Idaho Operations Office. A word cloud highlighting the 200 most popular words used in titles and abstracts is shown below.
+The **inlpubs** [R] package enables users to search and analyze `r npubs` publications spanning the `r nyears`-year history of the U.S. Geological Survey (USGS) Idaho Water Science Center and the Idaho National Laboratory Project Office ([INLPO]). Authored by `r nauthor` researchers, these publications provide valuable insights into the impacts of waste disposal on the eastern Snake River Plain aquifer and the availability of water for long-term consumptive and industrial use. The information within these publications is critical for the management and utilization of the aquifer by the Idaho National Laboratory ([INL]) and the State of Idaho. USGS geohydrologic studies and monitoring, initiated in 1920, were conducted in cooperation with the U.S. Department of Energy Idaho Operations Office.
-
+<p>
+ <figure class="figure">
+ <img src="man/figures/wordcloud.png" class="figure-img img-fluid" alt="photo" width="860px" />
+ <figcaption class="figure-caption">
+ A word cloud showcasing the 200 most frequently used words in titles and abstracts.
+ </figcaption>
+ </figure>
+</p>
## Installation
@@ -35,13 +42,17 @@ To install the current release of the package from [CRAN], you can use the follo
install.packages("inlpubs")
```
-To install the development version of the package, you need to clone the repository and build from source, or run the following commands:
+To install the package along with its dependencies, which are required to run examples in the package help documentation and build package datasets, run:
+
+```r
+install.packages("inlpubs", dependencies = TRUE)
+```
+
+To install the development version of the package, you can either clone the repository and build it from source, or run the following commands. Make sure the **remotes** package for R is installed.
```r
-if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_gitlab(
repo = "inl/inlpubs@develop",
- auth_token = Sys.getenv("GITLAB_PAT"),
host = "code.usgs.gov",
dependencies = TRUE
)
@@ -56,6 +67,15 @@ library("inlpubs")
help(package = "inlpubs")
```
+## Test
+
+The **tinytest** package is used for unit testing.
+To run the tests, use the following command:
+
+```r
+tinytest::test_package("inlpubs")
+```
+
## Authors
- Jason C. Fisher (ORCID iD [0000-0001-9032-8912])
@@ -94,7 +114,7 @@ The Idaho National Laboratory Project Office of the USGS supports the developmen
## Additional Publication Details
-This table contains additional metadata about this publication that is not found in other parts of the page.
+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::readCitationFile("inst/CITATION")
diff --git a/README.md b/README.md
index 15bb53d..733c1f0 100644
--- a/README.md
+++ b/README.md
@@ -6,23 +6,30 @@
## Description
-The [R](https://www.r-project.org/) package **inlpubs** may be used to
-search and analyze the 388 publications that cover the 76-year history
-of the U.S. Geological Survey ([USGS](https://www.usgs.gov/)), Idaho
-Water Science Center, Idaho National Laboratory Project Office
+The **inlpubs** [R](https://www.r-project.org/) package enables users to
+search and analyze 388 publications spanning the 76-year history of the
+U.S. Geological Survey (USGS) Idaho Water Science Center and the Idaho
+National Laboratory Project Office
([INLPO](https://www.usgs.gov/centers/idaho-water-science-center/science/idaho-national-laboratory-project-office)).
-The INLPO publications were authored by 263 researchers trying to better
-understand the effects of waste disposal on water contained in the
-eastern Snake River Plain aquifer and the availability of water for
-long-term consumptive and industrial use. Information contained within
-these publications is crucial to the management and use of the aquifer
-by the Idaho National Laboratory ([INL](https://inl.gov/)) and the State
-of Idaho. USGS geohydrologic studies and monitoring, which began in
-1920, were done in cooperation with the U.S. Department of Energy Idaho
-Operations Office. A word cloud highlighting the 200 most popular words
-used in titles and abstracts is shown below.
-
-
+Authored by 263 researchers, these publications provide valuable
+insights into the impacts of waste disposal on the eastern Snake River
+Plain aquifer and the availability of water for long-term consumptive
+and industrial use. The information within these publications is
+critical for the management and utilization of the aquifer by the Idaho
+National Laboratory ([INL](https://inl.gov/)) and the State of Idaho.
+USGS geohydrologic studies and monitoring, initiated in 1920, were
+conducted in cooperation with the U.S. Department of Energy Idaho
+Operations Office.
+
+<p>
+<figure class="figure">
+<img src="man/figures/wordcloud.png" class="figure-img img-fluid" alt="photo" width="860px" />
+<figcaption class="figure-caption">
+A word cloud showcasing the 200 most frequently used words in titles and
+abstracts.
+</figcaption>
+</figure>
+</p>
## Installation
@@ -34,14 +41,21 @@ following command in R:
install.packages("inlpubs")
```
-To install the development version of the package, you need to clone the
-repository and build from source, or run the following commands:
+To install the package along with its dependencies, which are required
+to run examples in the package help documentation and build package
+datasets, run:
+
+``` r
+install.packages("inlpubs", dependencies = TRUE)
+```
+
+To install the development version of the package, you can either clone
+the repository and build it from source, or run the following commands.
+Make sure the **remotes** package for R is installed.
``` r
-if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_gitlab(
repo = "inl/inlpubs@develop",
- auth_token = Sys.getenv("GITLAB_PAT"),
host = "code.usgs.gov",
dependencies = TRUE
)
@@ -57,6 +71,15 @@ library("inlpubs")
help(package = "inlpubs")
```
+## Test
+
+The **tinytest** package is used for unit testing. To run the tests, use
+the following command:
+
+``` r
+tinytest::test_package("inlpubs")
+```
+
## Authors
- Jason C. Fisher (ORCID iD
@@ -162,8 +185,8 @@ features.
## Additional Publication Details
-This table contains additional metadata about this publication that is
-not found in other parts of the page.
+Additional metadata about this publication, not found in other parts of
+the page is in this table.
<!--html_preserve-->
<table>
--
GitLab