README.Rmd 5.4 KB
Newer Older
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
1
2
3
4
5
6
7
---
output:
  md_document:
    variant: markdown_github
  md_extensions: -autolink_bare_uris+hard_line_breaks
---

8
9
10
11
12
13
14
15
16
```{r "package-info", include=FALSE}
cran_url <- "https://cran.r-project.org/"
package_version <- utils::available.packages(repos = cran_url)["inldata", "Version"]
xml <- rvest::read_html(file.path(cran_url, "web/packages/available_packages_by_date.html"))
xml_node <- rvest::html_nodes(xml, "table")[1]
d <- data.frame(rvest::html_table(xml_node, fill = TRUE)[1])
year_of_version <- format(as.Date(d[d$Package == "inldata", "Date"]), "%Y")
```

Fisher, Jason C.'s avatar
Fisher, Jason C. committed
17
18
19
20
21
22
23
24
# inldata

[![USGS Category](https://img.shields.io/badge/USGS-Research-blue.svg)](https://owi.usgs.gov/R/packages.html#research)
[![pipeline status](https://code.usgs.gov/inl/inldata/badges/master/pipeline.svg)](https://code.usgs.gov/inl/inldata/-/commits/master)
[![CRAN Version](https://www.r-pkg.org/badges/version/inldata)](https://CRAN.R-project.org/package=inldata)

## Description

25
The [R] package **inldata** is a collection of datasets for the U.S. Geological Survey-Idaho National Laboratory aquifer monitoring networks administrated by the [Idaho National Laboratory Project Office] in cooperation with the U.S. Department of Energy. Data collected from wells at the Idaho National Laboratory have been used to describe the effects of waste disposal on water contained in the eastern Snake River Plain aquifer, located in the southeastern part of Idaho, and the availability of water for long-term consumptive and industrial use. Included in this package are the long-term monitoring records, dating back to measurements from 1949, and the geospatial data describing the areas from which samples were collected or observations were made. Bundling this data into a single R package significantly reduces the magnitude of data processing for researches. And provides a way to distribute the data along with its documentation in a standard format. Geospatial datasets are made available in a common projection and datum, and geohydrologic data have been structured to facilitate analysis. A list of all datasets in the package is given below.
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
26
27

```{r "datasets", echo=FALSE, results="asis"}
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
28
29
m <- utils::data(package = "inldata")$results
d <- as.data.frame(m[, c("Item", "Title")], stringsAsFactors = FALSE)
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
30
31
32
33
34
35
36
colnames(d) <- c("Dataset", "Title")
d$Dataset <- sprintf("`%s`", d$Dataset)
knitr::kable(d)
```

## Installation

37
The current release (version `r package_version`) is available on [CRAN], which you can install using the following command:
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

```r
install.packages("inldata")
```

To also install user-contributed packages that **inldata** depends on to (1) run examples in the package help documentation, and (2) run code used to build package datasets, run:

```r
install.packages("inldata", dependencies = TRUE)
```

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

```r
if (!requireNamespace("remotes")) install.packages("remotes")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
53
54
55
56
remotes::install_gitlab("inl/inldata",
  host = "code.usgs.gov",
  dependencies = TRUE
)
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
57
58
59
60
61
62
63
64
65
66
67
68
69
```

## Usage

Examples are given in the package help pages. To access this documentation, run:

```r
library("inldata")
help(package = "inldata")
```

## Author

70
Jason C. Fisher (ORCID iD [0000-0001-9032-8912])
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
71
72
73
74
75
76
77
78
79
80

## Point of Contact

Jason C. Fisher (<jfisher@usgs.gov>)

## Suggested Citation

To cite **inldata** in publications, please use:

```{r "citation", echo=FALSE, results="asis"}
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
81
print(utils::citation(package = "inldata"), style = "textVersion")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
82
83
84
85
```

## Contributing

86
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.
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
87
88
89

```{r, echo=FALSE, results="asis"}
files <- c("CODE_OF_CONDUCT.md", "DISCLAIMER.md", "LICENSE.md")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
90
91
92
93
94
95
for (f in files) {
  txt <- readLines(f, encoding = "UTF-8")
  is <- grepl("^(#+)\\s*(.*)\\s*$", txt)
  txt[is] <- gsub("#\\s", "## ", txt[is])
  cat(txt, "\n\n", sep = "\n")
}
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
96
97
98
99
100
101
102
103
104
105
106
107
108
```

## Support

The Idaho National Laboratory Project Office of the USGS supports the development and maintenance of **inldata**. 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.

```{r "details", echo=FALSE, results="asis"}
m <- rbind(
  c("Publication type", "Formal R language package"),
109
  c("DOI", "10.5066/P9PP9UXZ"),
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
110
  c("Year published", "2020"),
111
112
113
114
115
  c("Year of version", year_of_version),
  c("Version", sprintf(
    "<a href='https://code.usgs.gov/inl/inldata/-/tree/v%s'>%s</a>",
    package_version, package_version
  )),
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
116
117
118
  c("IPDS", "IP-120865")
)
x <- "<table><tbody>"
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
119
for (i in seq_len(nrow(m))) {
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
120
121
122
  x <- c(x, sprintf("  <tr><th scope='row'>%s</th><td>%s</td></tr>", m[i, 1], m[i, 2]))
}
x <- c(x, "</tbody></table>  <cr>")
123
cat(sprintf("<!--html_preserve-->%s<!--/html_preserve-->", paste(x, collapse = "\n")))
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
124
```
125
126
127
128
129
130
131
132
133

<!-- Embedded References -->

[R]: https://www.r-project.org/
[Idaho National Laboratory Project Office]: https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office
[CRAN]: https://CRAN.R-project.org/package=inldata
[0000-0001-9032-8912]: https://orcid.org/0000-0001-9032-8912
[issue tracker]: https://code.usgs.gov/inl/inldata/-/issues
[merge request]: https://code.usgs.gov/inl/inldata/-/merge_requests