Commit 7883ccf0 authored by Fisher, Jason C.'s avatar Fisher, Jason C.
Browse files

Initial commit

parents
Pipeline #20842 passed with stages
in 9 minutes and 9 seconds
#' Idaho National Laboratory Boundary
#'
#' Boundary of the Idaho National Laboratory (\href{https://www.inl.gov/}{INL}).
#'
#' @format A SpatialPolygonsDataFrame of the \pkg{sp} package object with 1 feature and 4 variables.
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office}
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(inl, dms.tick = TRUE)
#' sp::plot(inl, col = "red", add = TRUE)
#' str(inl@data)
#'
"inl"
#' Map Labels
#'
#' Map labels in the vicinity of Idaho National Laboratory, eastern Idaho.
#'
#' @format A SpatialPointsDataFrame with 50 features and 7 variables:
#' \describe{
#' \item{\code{labels}}{text to be written}
#' \item{\code{cex}}{character expansion factor}
#' \item{\code{col}, \code{font}}{color and font to be used, respectively.}
#' \item{\code{srt}}{string rotation in degrees.}
#' \item{\code{halo}}{if true, a "halo" is printed around text.}
#' \item{\code{map}}{map index}
#' }
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office}
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(labels, dms.tick = TRUE)
#' lab <- labels[labels$map == 1L, names(labels) != "map"]
#' for (i in seq_along(lab))
#' do.call(raster::text, c(lab[i, ], as.list(lab@data[i, ])))
#' str(labels@data)
#'
"labels"
#' Lakes and Ponds
#'
#' Perennial lakes and ponds in the vicinity of Idaho National Laboratory, eastern Idaho.
#'
#' @format A SpatialPolygonsDataFrame with 167 features of 12 variables.
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source U.S. Geological Survey (USGS), National Geospatial Technical Operations Center,
#' USGS National Hydrography Dataset (NHD) Medium Resolution for Idaho,
#' released August 4, 2014.
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(lakes, dms.tick = TRUE,
#' lakes = list(lakes, "lwd" = 1))
#' str(lakes@data)
#'
"lakes"
#' Mountain Ranges and Buttes
#'
#' Simplified representation of the mountain ranges and buttes in the
#' vicinity of Idaho National Laboratory, eastern Idaho.
#'
#' @format A SpatialPolygonsDataFrame of the \pkg{sp} package object with 17 features and 1 variable.
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office}
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(mountains, dms.tick = TRUE)
#' sp::plot(mountains, col = "gray", add = TRUE)
#' str(mountains@data)
#'
"mountains"
#' Parameter Information for Analytes
#'
#' Parameter code information for selected chemical constituents,
#' organic compounds, and radionuclides measured for in water samples collected from
#' wells in the U.S. Geological Survey (USGS) water-quality aquifer monitoring network,
#' Idaho National Laboratory and vicinity, Idaho.
#'
#' @format A data.frame with 74 records and 7 variables:
#' \describe{
#' \item{\code{parm_cd}}{USGS 5-digit parameter code}
#' \item{\code{parameter_group_nm}}{parameter group name, such as \code{"Radiochemical"}}
#' \item{\code{parameter_nm}}{long parameter name, such as \code{"Strontium-90, water, unfiltered, picocuries per liter"}}
#' \item{\code{casrn}}{Chemical Abstracts Service
#' (\href{https://www.cas.org/content/chemical-substances/faqs}{CAS}) registry number,
#' such as \code{"10098-97-2"} for Strontium-90}
#' \item{\code{srsname}}{Substance Registry Services
#' (\href{https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do}{SRS}) name,
#' such as \code{"Strontium-90"}}
#' \item{\code{parameter_units}}{parameter units.
#' Unit abbreviations and descriptions are:
#' \code{"mg/L"} milligrams per liter,
#' \code{"mg/L as N"} milligrams per liter as Nitrogen,
#' \code{"ug/L"} microgram per liter, and
#' \code{"pCi/L"} picocuries per liter.}
#' \item{\code{siunitx}}{parameter units formatted for LaTeX using the \code{siunitx} package notation.}
#' }
#'
#' @source USGS water data acquired from the National Water Information System (U.S. Geological Survey, 2019).
#' The \href{https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do}{SRS} name (\code{srsname})
#' for "Trihalomethanes (four), total, from SDWA NPDWR" was shorten to its preferred acronym "TTHM4".
#'
#' @references U.S. Geological Survey, 2019, National Water Information System---web services,
#' accessed June 11, 2019, from \url{https://doi.org/10.5066/F7P55KJN}.
#'
#' @keywords datasets
#'
#' @examples
#' str(parameters)
#'
"parameters"
#' Coordinate Reference System
#'
#' \href{https://proj4.org/}{PROJ.4} string defining a
#' custom coordinate reference system (CRS) used by the
#' U.S. Geological Survey Idaho National Laboratory Project Office.
#' The CRS is based on the following attributes:
#' Albers equal-area conic projection;
#' latitude of first and second standard parallel is 42.83 and 44.16 decimal degrees, respectively;
#' latitude and longitude of false origin is 41.5 and -113 decimal degrees, respectively;
#' easting and northing of false origin is 200,000 and 0 meters, respectively;
#' Clarke (1966) reference ellipsoid;
#' North American Datum of 1983; and
#' units of meters.
#'
#' @format A character string describing the CRS in PROJ.4 format.
#'
#' @keywords datasets
#' @examples
#' crs <- sp::CRS(projection) # convert to class "CRS"
#' print(crs)
#'
"projection"
#' Primary and Secondary Roads
#'
#' Primary and secondary roads in the vicinity of Idaho National Laboratory, eastern Idaho.
#'
#' @format A SpatialLinesDataFrame of the \pkg{sp} with 1920 features and 5 variables.
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source U.S. Department of Commerce, U.S. Census Bureau, Geography Division/Cartographic Products Branch.
#' Spatial extract from the Master Address File / Topologically Integrated Geographic Encoding and Referencing
#' (\href{https://catalog.data.gov/dataset/tiger-line-shapefile-2019-series-information-for-the-current-place-state-based-shapefile}{MAF/TIGER}) Database (MTDB),
#' 2019 data collection, released April 2, 2020.
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(roads, dms.tick = TRUE,
#' roads = list(roads, "lwd" = 1))
#' sp::plot(roads[roads@data$PRISEC, ], col = "red", add = TRUE)
#' str(roads@data)
#'
"roads"
#' Water-Quality Data Records
#'
#' Water-quality data from laboratory analyses of groundwater samples
#' collected from wells in the U.S. Geological Survey (USGS) water-quality monitoring network,
#' Idaho National Laboratory and vicinity, Idaho.
#' Data was obtained from the National Water Information System (U.S. Geological Survey, 2019).
#'
#' @format A data.frame with 159,554 records and 19 variables:
#' \describe{
#' \item{\code{site_no}}{USGS site identification number}
#' \item{\code{sample_dt}}{date sample was collected}
#' \item{\code{medium_cd}}{3-digit medium code that identifies the material type and quality assurance type of the sample.
#' The codes and their meanings are:
#' \code{"WG"} water below land surface contained in the saturated zone (groundwater); and
#' \code{"WGQ"} groundwater quality-control (QC) sample.}
#' \item{\code{db_no}}{2-digit NWIS database number.
#' The codes and their meanings are:
#' \code{"01"} is the environmental database, and
#' \code{"10"} is the quality-assurance (QA) database.}
#' \item{\code{anl_ent_cd}}{analyzing entity code of the organizational unit that
#' performed the sample analysis used to obtain the result.}
#' \item{\code{parm_cd}}{USGS 5-digit parameter code.
#' For example, the parameter code for Tritium is \code{"07000"}.}
#' \item{\code{remark_cd}}{1-digit remark code (result level) used to qualify the parameter value.
#' The codes and their meanings are:
#' \code{""} quantified value.
#' \code{"<"} actual value is known to be less than the value reported,
#' that is, the measured concentration is below the reporting limit (RL) and represented as a censored (or nondetection) value.
#' For censored values, the value reported is the RL.
#' \code{"E"} value is estimated, that is, the actual value is greater than the minimum detection limit (MDL)
#' and less than the laboratory reporting level (LRL).
#' \code{"R"} nondetect, result less than sample-specific critical level.
#' \code{"U"} material specifically analyzed for but not detected.
#' \code{"V"} value affected by contamination.}
#' \item{\code{result_va}}{parameter value;
#' see \code{parameter_units} variable in the \code{\link{parameters}} dataset for the units of measurement.}
#' \item{\code{lab_std_dev_va}}{laboratory standard deviation (SD).
#' For radiochemical data, SD is determined from the counting error.
#' Prior to January 1, 2018, counting error was reported as two SD, therefore, these values were divied by 2.}
#' \item{\code{dqi_cd}}{1-digit data quality indicator code that indicates the review status of a result.
#' The codes and their meanings are:
#' \code{"A"} historical data,
#' \code{"S"} presumed satisfactory, and
#' \code{"R"} reviewed and accepted.}
#' \item{\code{rpt_lev_va}}{laboratory reporting limit in effect for the parameter and
#' method at the time the measurement was made.}
#' \item{\code{rpt_lev_cd}}{reporting level code that identifies the analytical reporting level appropriate for the analytical method.
#' The codes and their meanings are:
#' \code{"DLBLK"} detection limit by blank data;
#' \code{"DLDQC"} detection limit by DQCALC, lowest concentration that with 90 percent confidence will be exceeded no more than
#' 1 percent of the time when a blank sample is measured;
#' \code{"IRL"} interim reporting level, a temporary reporting level;
#' \code{"LRL"} laboratory reporting level, equal to twice the yearly-determined LT-MDL;
#' \code{"LT-MDL"} long-term method detection limit, a detection level derived by determining the standard deviation of
#' a minimum of 24 MDL spike sample measurements over an extended period of time;
#' \code{"MDL"} method detection limit, minimum concentration of a substance that can be measured and reported with
#' a 99 percent confidence that the analyte concentration in greater than zero;
#' \code{"PQL"} practical quantitation limits;
#' \code{"MRL"} minimum reporting level, smallest measured concentration that can be reliably measured using
#' a given analytical method;
#' \code{"RLDQC"} reporting limit by DQCALC, is greater than or equal to two times the DLDQC;
#' \code{"SSLC"} sample-specific critical level, the calculated and reported value is below which the radiochemistry result
#' is considered a non-detect; and
#' \code{"SSMDC"} sample-specific minimum detectable concentration, a reporting level that varies for each sample and is primarily used
#' in radiochemical analyses.}
#' \item{\code{samp_type_cd}}{1-digit sample type code that identifies the QA type of a sample.
#' The codes and their meanings are:
#' \code{"H"} samples collected over a period of time (composite);
#' \code{"2"} samples prepared from a reference material where none of the analytes of interest are
#' present in detectable quantities (blank);
#' \code{"6"} reference material that provide the baseline analytical results for comparison with reference samples;
#' \code{"7"} replicate samples; and
#' \code{"9"} sample taken from the environment (regular).}
#' \item{\code{meth_cd}}{method code, the codes are documented in the
#' "\href{https://help.waterdata.usgs.gov/code/method_cd_query}{NWIS Method Code Dictionary}"}
#' \item{\code{result_cm_tx}}{comment about the water quality result}
#' \item{\code{date_time}}{date and time the sample was collected.
#' Missing values of time were substituted with \dQuote{00:00} (12:00 midnight and start of day).}
#' \item{\code{sample_cd}}{unique identifier for the water sample.
#' The sample code is a concatenation of the \code{date_time} and \code{site_no} variables.}
#' \item{\code{comments}}{comments pertaining to changes applied after the records were obtained from NWIS.}
#' \item{\code{rep_pair_no}}{number used to identify replicate samples.
#' Replicates are identified by matching a replicate sample (\code{samp_type_cd} eqaul to 7) with
#' its corresponding environmental sample (\code{samp_type_cd} equal to 9).}
#' }
#'
#' @source Data obtained from the NWIS-QWDATA database on June 11, 2019 using the QWDATA system (U.S. Geological Survey, 2019).
#'
#' @references
#' U.S. Geological Survey, 2019, National Water Information System---Water-Quality System (QWDATA)
#' data retrieval program.
#'
#' @keywords datasets
#'
#' @examples
#' site_no <- "433002113021701" # well RWMC PROD
#' parm_cd <- "32102" # carbon tetrachloride
#' xlim <- as.Date(c("1989-01-01", "2019-01-01"))
#' d <- samples[samples$site_no == site_no & samples$parm_cd == parm_cd,
#' c("sample_dt", "result_va")]
#' ylab <- parameters[parameters$parm_cd == parm_cd, "parameter_nm"]
#' main <- sites@data[sites@data$site_no == site_no, "site_nm"]
#' inlmisc::PlotGraph(d, ylab = ylab, main = main, xlim = xlim,
#' type = "p", pch = 19, seq.date.by = "year",
#' center.date.labels = TRUE)
#' str(samples)
#'
"samples"
#' Descriptive Site Information
#'
#' Information for sampling sites in the U.S. Geological Survey (USGS)
#' aquifer monitoring networks, Idaho National Laboratory and vicinity, Idaho.
#'
#' @format A SpatialPointsDataFrame of the \pkg{sp} package with 182 records and 21 variables:
#' \describe{
#' \item{\code{site_no}}{USGS site number for monitoring well}
#' \item{\code{station_nm}}{USGS site name}
#' \item{\code{coord_meth_cd}}{latitude/longitude coordinate method code.
#' The codes and their meanings are:
#' "D" differentially corrected Global Positioning System (GPS),
#' "G" mapping grade GPS unit (handheld accuracy range 3.7 to 12.2 meters),
#' "L" long range navigation system,
#' "M" interpolated from topographic map, and
#' "S" transit, theodolite, or other surveying method.}
#' \item{\code{coord_acy_cd}}{accuracy code for latitude/longitude values.
#' The codes and their meanings are:
#' "H" accurate to \eqn{\pm}{+/-} 0.1 second,
#' "5" accurate to \eqn{\pm}{+/-} 0.5 second,
#' "S" accurate to \eqn{\pm}{+/-} 1 second, and
#' "F" accurate to \eqn{\pm}{+/-} 5 seconds.}
#' \item{\code{alt_va}}{elevation of the land surface reference point,
#' in feet above the North American Vertical Datum of 1988.}
#' \item{\code{alt_meth_cd}}{method code for measuring elevation.
#' The codes and their meanings are:
#' "D" differentially corrected global positioning system,
#' "L" level or other surveyed method, and
#' "M" interpolated from topographic map.}
#' \item{\code{alt_acy_va}}{accuracy of the elevation value (alt_va),
#' does not account for vertical datum shift.}
#' \item{\code{construction_dt}}{date the well was completed.}
#' \item{\code{huc_cd}}{hydrologic unit code (HUC).
#' Hydrologic units are geographic areas representing part or all of a surface drainage basin or
#' distinct hydrologic feature and are delineated on the
#' \href{https://water.usgs.gov/GIS/regions.html}{Hydrologic Unit Map}.}
#' \item{\code{reliability_cd}}{reliability code for data available for the site.
#' The codes and their meanings are:
#' "C" data have been checked by the reporting agency, and
#' "U" unchecked data.}
#' \item{\code{nat_aqfr_cd}}{national aquifer codes}
#' \item{\code{aqfr_cd}}{aquifer codes defined by the catalog of aquifer names and
#' geologic unit codes used by the Water Mission Area.}
#' \item{\code{aqfr_type_cd}}{aquifer type code.
#' The codes and their meanings are:
#' "C" confined single aquifer,
#' "M" confined multiple aquifers,
#' "U" unconfined single aquifer, and
#' "X" mixed (confined and unconfined) multiple aquifers.}
#' \item{\code{well_depth_va}}{depth of the finished well, in feet below the land surface datum}
#' \item{\code{hole_depth_va}}{total depth of the borehole, in feet below the land surface datum}
#' \item{\code{depth_src_cd}}{source code for depth measurements.
#' The codes and their meanings are:
#' "A" reported by another government agency,
#' "D" from driller's log or report,
#' "G" private geologist-consultant or university associate,
#' "L" interpreted from geophysical logs by personnel of source agency,
#' "O" reported by owner of well,
#' "R" reported by person other than the owner, driller, or another government agency, and
#' "S" measured by personnel of reporting agency.}
#' \item{\code{site_nm}}{local site name}
#' \item{\code{completion_cd}}{borehole completion code.
#' The codes and their meanings are:
#' "O" open hole completion,
#' "M" multilevel completion, and
#' "P" open hole completion prior to multilevel completion.}
#' \item{\code{network}}{aquifer monitoring network,
#' either "aquifer" or "perched".}
#' \item{\code{pos}}{a position specifier for site-labels on a map.
#' Values of 1, 2, 3 and 4, respectively indicate positions below, to the left of,
#' above and to the right of the site coordinates.}
#' }
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source USGS site data acquired from the NWIS (U.S. Geological Survey, 2020).
#'
#' @references U.S. Geological Survey, 2020, National Water Information System---web services,
#' accessed August 4, 2020, from \url{https://doi.org/10.5066/F7P55KJN}.
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(sites, dms.tick = TRUE)
#' sp::plot(sites, add = TRUE)
#' str(sites@data)
#'
"sites"
#' Rivers and Streams
#'
#' Stream segments in the vicinity of Idaho National Laboratory, eastern Idaho.
#'
#' @format A SpatialLinesDataFrame with 201 features of 12 variables.
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source U.S. Geological Survey (USGS), National Geospatial Technical Operations Center,
#' USGS National Hydrography Dataset (NHD) Medium Resolution for Idaho,
#' released August 4, 2014.
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(streams, dms.tick = TRUE,
#' rivers = list(streams, "lwd" = 1))
#' str(streams@data)
#'
"streams"
#' Land-Surface Topography
#'
#' Land-surface topography and shaded relief
#' in the vicinity of Idaho National Laboratory, eastern Idaho.
#'
#' @format A RasterStack of the \pkg{sp} package with 2 layers.
#' Grid cells in the \code{"elevation"} layer represent land-surface elevations in meters above the
#' North American Vertical Datum of 1988 (NAVD 88).
#' Grid cells in the \code{"hillshade"} layer represent shaded relief calculated from
#' the slope and aspect of land-surface elevations.
#' The spatial grid is composed of 900 rows and 900 columns,
#' and has cell sizes that are constant at 100 meters by 100 meters.
#' See \code{\link{projection}} dataset for coordinate reference system information.
#'
#' @source The National Map (\href{https://nationalmap.gov/elevation.html}{TNM})
#' 1/3-arc-second DEM (Gesch, 2007; Gesch and others, 2002), accessed on August 4, 2020.
#' This dataset can be downloaded in a Esri ArcGRID \eqn{\textsuperscript{TM}}{™} format using
#' \href{https://viewer.nationalmap.gov/basic/}{TNM Download}.
#' Elevation datasets are distributed in geographic coordinates in units of decimal degrees,
#' and in conformance with the NAD 83.
#' Elevation values are in meters above the NAVD 88.
#' The west, east, south, and north bounding coordinates for this dataset are
#' -114, -112, 43, and 45 decimal degrees, respectively.
#'
#' @references Gesch, D.B., 2007, The National Elevation Dataset, in Maune, D., ed.,
#' Digital Elevation Model Technologies and Applications---The DEM Users Manual,
#' 2nd ed.: Bethesda, Maryland, American Society for Photogrammetry and Remote Sensing,
#' p. 99--118.
#'
#' Gesch, D., Oimoen, M., Greenlee, S., Nelson, C., Steuck, M., and Tyler, D., 2002,
#' The National Elevation Dataset: Photogrammetric Engineering and Remote Sensing,
#' v. 68, no. 1, p. 5--11.
#'
#' @keywords datasets
#'
#' @examples
#' inlmisc::PlotMap(topo[["elevation"]], bg.image = topo[["hillshade"]],
#' pal = inlmisc::GetColors(scheme = "dem3", alpha = 0.5),
#' dms.tick = TRUE, useRaster = TRUE)
#'
"topo"
.onAttach <- function(lib, pkg) {
if (interactive()) {
ver <- read.dcf(file.path(lib, pkg, "DESCRIPTION"), "Version")
msg <- "USGS Research Package: https://owi.usgs.gov/R/packages.html#research"
packageStartupMessage(paste(strwrap(msg), collapse="\n"))
}
invisible()
}
---
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
The [R](https://www.r-project.org/) 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](https://www.usgs.gov/centers/id-water/science/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.
```{r "datasets", echo=FALSE, results="asis"}
m <- utils::data(package="inldata")$results
d <- as.data.frame(m[, c("Item", "Title")], stringsAsFactors=FALSE)
colnames(d) <- c("Dataset", "Title")
d$Dataset <- sprintf("`%s`", d$Dataset)
knitr::kable(d)
```
## Installation
The current release is available on [CRAN](https://CRAN.R-project.org/package=inldata "The Comprehensive R Archive Network"), which you can install using the following command:
```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")
remotes::install_gitlab("inl/inldata", host = "code.usgs.gov",
dependencies = TRUE)
```
## Usage
Examples are given in the package help pages. To access this documentation, run:
```r
library("inldata")
help(package = "inldata")
```
## Author
Jason C. Fisher (ORCID iD [0000-0001-9032-8912](http://orcid.org/0000-0001-9032-8912))
## Point of Contact
Jason C. Fisher (<jfisher@usgs.gov>)
## Suggested Citation
To cite **inldata** in publications, please use:
```{r "citation", echo=FALSE, results="asis"}
print(utils::citation(package="inldata"), style="textVersion")
```
## Contributing
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](https://code.usgs.gov/inl/inldata/-/issues) or open a [merge request](https://code.usgs.gov/inl/inldata/-/merge_requests) to contribute.
```{r, echo=FALSE, results="asis"}
files <- c("CODE_OF_CONDUCT.md", "DISCLAIMER.md", "LICENSE.md")
for (f in files) cat(readLines(f), "\n\n", sep="\n")
```
## 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.
```{r "support", echo=FALSE, results="asis"}
cat(readLines("DISCLAIMER.md"), sep="\n")
```
## 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"),
c("DOI", "10.3133/P9PP9UXZ"),
c("Year published", "2020"),
c("Year of version", format(utils::packageDate("inldata"), format="%Y")),
c("Version", format(utils::packageVersion("inldata"))),
c("IPDS", "IP-120865")
)
x <- "<table><tbody>"
for (i in 1:nrow(m)) {
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>")
tbl <- paste(x, collapse="\n")
tbl <- sprintf("<!--html_preserve-->%s<!--/html_preserve-->", tbl)
cat(tbl)
```
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
-----------
The [R](https://www.r-project.org/) 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](https://www.usgs.gov/centers/id-water/science/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.
| Dataset | Title |
|:-------------|:-------------------------------------|
| `background` | Background Concentrations |
| `benchmarks` | Benchmark Concentrations |
| `cities` | Cities and Towns |
| `counties` | County Boundaries |
| `dl` | Laboratory Detection Limits |
| `esrp` | Eastern Snake River Plain Boundary |
| `facilities` | Idaho National Laboratory Facilities |
| `gwl` | Groundwater Level Measurements |
| `idaho` | State of Idaho Boundary |
| `inl` | Idaho National Laboratory Boundary |
| `labels` | Map Labels |
| `lakes` | Lakes and Ponds |
| `mountains` | Mountain Ranges and Buttes |
| `parameters` | Parameter Information for Analytes |
| `projection` | Coordinate Reference System |
| `roads` | Primary and Secondary Roads |
| `samples` | Water-Quality Data Records |
| `sites` | Descriptive Site Information |
| `streams` | Rivers and Streams |
| `topo` | Land-Surface Topography |
Installation
------------
The current release is available on
[CRAN](https://CRAN.R-project.org/package=inldata "The Comprehensive R Archive Network"),
which you can install using the following command:
``` 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")
remotes::install_gitlab("inl/inldata", host = "code.usgs.gov",
dependencies = TRUE)
```
Usage
-----