README.Rmd 4.95 KB
Newer Older
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
---
output:
  md_document:
    variant: markdown_github
  md_extensions: -autolink_bare_uris+hard_line_breaks
---

# 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

16
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
17
18

```{r "datasets", echo=FALSE, results="asis"}
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
19
20
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
21
22
23
24
25
26
27
colnames(d) <- c("Dataset", "Title")
d$Dataset <- sprintf("`%s`", d$Dataset)
knitr::kable(d)
```

## Installation

28
The current release is available on [CRAN], which you can install using the following command:
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

```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
44
45
46
47
remotes::install_gitlab("inl/inldata",
  host = "code.usgs.gov",
  dependencies = TRUE
)
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
48
49
50
51
52
53
54
55
56
57
58
59
60
```

## Usage

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

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

## Author

61
Jason C. Fisher (ORCID iD [0000-0001-9032-8912])
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
62
63
64
65
66
67
68
69
70
71

## 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
72
print(utils::citation(package = "inldata"), style = "textVersion")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
73
74
75
76
```

## Contributing

77
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
78
79
80

```{r, echo=FALSE, results="asis"}
files <- c("CODE_OF_CONDUCT.md", "DISCLAIMER.md", "LICENSE.md")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
81
82
83
84
85
86
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
87
88
89
90
91
92
93
94
95
96
97
98
99
```

## 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"),
100
  c("DOI", "<a href='https://doi.org/10.5066/P9PP9UXZ'>10.5066/P9PP9UXZ</a>"),
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
101
  c("Year published", "2020"),
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
102
  c("Year of version", "2020"),
103
  c("Version", "<a href='https://code.usgs.gov/inl/inldata/-/tree/v1.0.3'>1.0.3</a>"),
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
104
105
106
  c("IPDS", "IP-120865")
)
x <- "<table><tbody>"
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
107
for (i in seq_len(nrow(m))) {
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
108
109
110
  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>")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
111
tbl <- paste(x, collapse = "\n")
Fisher, Jason C.'s avatar
Fisher, Jason C. committed
112
113
114
tbl <- sprintf("<!--html_preserve-->%s<!--/html_preserve-->", tbl)
cat(tbl)
```
115

116
117
118



119
120
121
122
123
124
125
126
<!-- 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