Skip to content

GitLab

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

Leverage markdown in help documentation

parent a6e5a08e
Pipeline #58605 passed with stage
in 10 minutes and 33 seconds
Hide whitespace changes
Inline Side-by-side
DESCRIPTION
View file @ 62918289
...@@ -35,4 +35,5 @@ Copyright: This software is in the public domain because it contains materials ...@@ -35,4 +35,5 @@ Copyright: This software is in the public domain because it contains materials
Encoding: UTF-8 Encoding: UTF-8
LazyData: true LazyData: true
LazyDataCompression: xz LazyDataCompression: xz
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1 RoxygenNote: 7.1.1
R/background.R
View file @ 62918289
...@@ -8,20 +8,20 @@ ...@@ -8,20 +8,20 @@
#' and are not influenced by waste and wastewater disposal at the INL #' and are not influenced by waste and wastewater disposal at the INL
#' (Bartholomay and Hall, 2016, p. 3). #' (Bartholomay and Hall, 2016, p. 3).
#' #'
#' @format A data frame with 73 records and 4 variables: #' @format A data frame with 4 variables:
#' \describe{ #' \describe{
#' \item{\code{parm_cd}}{U.S. Geological Survey 5-digit parameter code, #' \item{`parm_cd`}{U.S. Geological Survey 5-digit parameter code,
#' see \code{\link{parameters}} dataset for details.} #' see [`parameters`] dataset for details.}
#' \item{\code{bkgrd_min}, \code{bkgrd_max}}{minimum and maximum limits of background concentration} #' \item{`bkgrd_min`, `bkgrd_max`}{minimum and maximum limits of background concentration}
#' \item{\code{reference}}{source of background concentration limits. #' \item{`reference`}{source of background concentration limits.
#' Reference citations are: #' Reference citations are:
#' \code{"Bartholomay and Hall (2016)"}, #' `"Bartholomay and Hall (2016)"`,
#' \code{"Knobel and others (1992)"}, #' `"Knobel and others (1992)"`,
#' \code{"Michel (1989)"}, and #' `"Michel (1989)"`, and
#' \code{"Orr and others (1991)"}.} #' `"Orr and others (1991)"`.}
#' } #' }
#' Row names for the data frame indicate the Substance Registry Services #' Row names for the data frame indicate the Substance Registry Services
#' (\href{https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do}{SRS}) #' ([SRS](https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do))
#' name and parameter units. #' name and parameter units.
#' #'
#' @references Bartholomay, R.C., and Hall, L.F., 2016, Evaluation of background concentrations #' @references Bartholomay, R.C., and Hall, L.F., 2016, Evaluation of background concentrations
...@@ -50,5 +50,4 @@ ...@@ -50,5 +50,4 @@
#' @examples #' @examples
#' str(background) #' str(background)
#' rownames(background) #' rownames(background)
#' "background"
"background" \ No newline at end of file
R/benchmarks.R
View file @ 62918289
...@@ -3,32 +3,32 @@ ...@@ -3,32 +3,32 @@
#' Water-quality benchmark concentrations of #' Water-quality benchmark concentrations of
#' selected radionuclides, organic compounds, and chemical constituents. #' selected radionuclides, organic compounds, and chemical constituents.
#' Benchmarks include: #' Benchmarks include:
#' the U.S. Environmental Protection Agency (USEPA) Maximum Contaminant Levels #' U.S. Environmental Protection Agency (USEPA) Maximum Contaminant Levels
#' (\href{https://www.epa.gov/ground-water-and-drinking-water/national-primary-drinking-water-regulations}{MCLs}) and #' ([MCLs](https://www.epa.gov/ground-water-and-drinking-water/national-primary-drinking-water-regulations)),
#' Human Health Benchmarks for Pesticides #' Human Health Benchmarks for Pesticides
#' (\href{https://iaspub.epa.gov/apex/pesticides/f?p=HHBP:home}{HHBPs}), and #' ([HHBPs](https://iaspub.epa.gov/apex/pesticides/f?p=HHBP:home)), and
#' the U.S. Geological Survey (USGS) Health-Based Screening Levels #' U.S. Geological Survey (USGS) Health-Based Screening Levels
#' (\href{https://water.usgs.gov/water-resources/hbsl/}{HBSLs}). #' ([HBSLs](https://water.usgs.gov/water-resources/hbsl/)).
#' #'
#' @format A data frame with 74 records and 9 variables: #' @format A data frame with 9 variables:
#' \describe{ #' \describe{
#' \item{\code{parm_cd}}{USGS 5-digit parameter code, see \code{\link{parameters}} dataset for details.} #' \item{`parm_cd`}{USGS 5-digit parameter code, see [`parameters`] dataset for details.}
#' \item{\code{mcl}}{USEPA MCLs.} #' \item{`mcl`}{USEPA MCLs.}
#' \item{\code{hhbp_noncancer}}{USEPA Chronic Noncancer HHBPs} #' \item{`hhbp_noncancer`}{USEPA Chronic Noncancer HHBPs}
#' \item{\code{hhbp_cancer_min}}{USEPA Carcinogenic HHBPs for a one-in-one million cancer risk.} #' \item{`hhbp_cancer_min`}{USEPA Carcinogenic HHBPs for a one-in-one million cancer risk.}
#' \item{\code{hhbp_cancer_max}}{USEPA Carcinogenic HHBPs for a one-in-ten thousand cancer risk.} #' \item{`hhbp_cancer_max`}{USEPA Carcinogenic HHBPs for a one-in-ten thousand cancer risk.}
#' \item{\code{hbsl_noncancer}}{USGS Noncancer HBSLs} #' \item{`hbsl_noncancer`}{USGS Noncancer HBSLs}
#' \item{\code{hbsl_cancer_min}}{USGS Cancer HBSLs for a one-in-one million cancer risk.} #' \item{`hbsl_cancer_min`}{USGS Cancer HBSLs for a one-in-one million cancer risk.}
#' \item{\code{hbsl_cancer_max}}{USGS Cancer HBSLs for a one-in-ten thousand cancer risk.} #' \item{`hbsl_cancer_max`}{USGS Cancer HBSLs for a one-in-ten thousand cancer risk.}
#' \item{\code{remark}}{comments} #' \item{`remark`}{comments}
#' } #' }
#' Row names for the data frame indicate the Substance Registry Services #' Row names for the data frame indicate the Substance Registry Services
#' (\href{https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do}{SRS}) #' ([SRS](https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do))
#' name and parameter units. #' name and parameter units.
#' #'
#' @source Many of the water-quality benchmarks were accessed from the #' @source Many of the water-quality benchmarks were accessed from the
#' U.S. Geological Survey Health-Based Screening Levels database, #' U.S. Geological Survey Health-Based Screening Levels database,
#' accessed on August 8, 2017, from \url{https://water.usgs.gov/water-resources/hbsl/}. #' accessed on August 8, 2017, from <https://water.usgs.gov/water-resources/hbsl/>.
#' Benchmarks for total Trihalomethanes, Tritium, and Strontium-90 were #' Benchmarks for total Trihalomethanes, Tritium, and Strontium-90 were
#' provided by the U.S. Environmental Protection Agency (2015). #' provided by the U.S. Environmental Protection Agency (2015).
#' Note that MCL benchmark values reported in millirem per year were #' Note that MCL benchmark values reported in millirem per year were
...@@ -46,5 +46,4 @@ ...@@ -46,5 +46,4 @@
#' @examples #' @examples
#' str(benchmarks) #' str(benchmarks)
#' rownames(benchmarks) #' rownames(benchmarks)
#' "benchmarks"
"benchmarks" \ No newline at end of file
R/cities.R
View file @ 62918289
...@@ -2,13 +2,13 @@ ...@@ -2,13 +2,13 @@
#' #'
#' Cities and towns (populated places) in the vicinity of Idaho National Laboratory, eastern Idaho. #' Cities and towns (populated places) in the vicinity of Idaho National Laboratory, eastern Idaho.
#' #'
#' @format A SpatialPointsDataFrame of the \pkg{sp} package with 24 records and 16 variables. #' @format A SpatialPointsDataFrame of the \pkg{sp} package with 16 variables.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Department of Commerce, U.S. Census Bureau, Geography Division/Cartographic Products Branch. #' @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 #' 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), #' ([MAF/TIGER](https://catalog.data.gov/dataset/tiger-line-shapefile-2019-series-information-for-the-current-place-state-based-shapefile))
#' 2019 data collection, released April 2, 2020. #' Database (MTDB), 2019 data collection, released April 2, 2020.
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
#' inlmisc::PlotMap(cities, dms.tick = TRUE) #' inlmisc::PlotMap(cities, dms.tick = TRUE)
#' sp::plot(cities, pch = 19, add = TRUE) #' sp::plot(cities, pch = 19, add = TRUE)
#' raster::text(cities, cities@data$NAME, #' raster::text(cities, cities@data$NAME,
#' pos = 1, cex = 0.6) #' pos = 1, cex = 0.6
#' )
#' str(cities@data) #' str(cities@data)
#' "cities"
"cities" \ No newline at end of file
R/counties.R
View file @ 62918289
#' County Boundaries #' County Boundaries
#' #'
#' Boundaries of counties #' Boundaries of counties in the vicinity of Idaho National Laboratory, eastern Idaho, as of January 1, 2015.
#' in the vicinity of Idaho National Laboratory, eastern Idaho, as of January 1, 2015.
#' #'
#' @format A SpatialLines of the \pkg{sp} package with 45 features. #' @format A SpatialLines of the \pkg{sp} package with 45 features.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Department of Commerce, U.S. Census Bureau, Geography Division/Cartographic Products Branch. #' @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 #' 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), #' ([MAF/TIGER](https://catalog.data.gov/dataset/tiger-line-shapefile-2019-series-information-for-the-current-place-state-based-shapefile))
#' 2019 data collection, released April 2, 2020. #' Database (MTDB), 2019 data collection, released April 2, 2020.
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
#' @examples #' @examples
#' inlmisc::PlotMap(counties, dms.tick = TRUE) #' inlmisc::PlotMap(counties, dms.tick = TRUE)
#' sp::plot(counties, lty = 5, add = TRUE) #' sp::plot(counties, lty = 5, add = TRUE)
#' "counties"
"counties" \ No newline at end of file
R/dl.R
View file @ 62918289
...@@ -3,15 +3,15 @@ ...@@ -3,15 +3,15 @@
#' Analytical method detection limits of selected radionuclides, #' Analytical method detection limits of selected radionuclides,
#' which are based on laboratory procedures. #' which are based on laboratory procedures.
#' #'
#' @format A data frame with 8 records and 6 variables: #' @format A data frame with 6 variables:
#' \describe{ #' \describe{
#' \item{\code{srsname}}{Substance Registry Services #' \item{`srsname`}{Substance Registry Services
#' (\href{https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do}{SRS}) name.} #' ([SRS](https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do)) name.}
#' \item{\code{parm_cd}}{U.S. Geological Survey 5-digit parameter code.} #' \item{`parm_cd`}{U.S. Geological Survey 5-digit parameter code.}
#' \item{\code{parameter_units}}{parameter units} #' \item{`parameter_units`}{parameter units}
#' \item{\code{lab_det_lim_va}}{laboratory detection limit concentration} #' \item{`lab_det_lim_va`}{laboratory detection limit concentration}
#' \item{\code{sdate}}{date that the detection limit went into effect.} #' \item{`sdate`}{date that the detection limit went into effect.}
#' \item{\code{reference}}{source of detection limit.} #' \item{`reference`}{source of detection limit.}
#' } #' }
#' #'
#' @source Detection limits reported by: #' @source Detection limits reported by:
...@@ -29,15 +29,14 @@ ...@@ -29,15 +29,14 @@
#' Field methods and quality-assurance plan for water-quality activities and #' Field methods and quality-assurance plan for water-quality activities and
#' water-level measurements, U.S. Geological Survey, Idaho National Laboratory, Idaho: #' water-level measurements, U.S. Geological Survey, Idaho National Laboratory, Idaho:
#' U.S. Geological Survey Open-File Report 2014--1146 (DOE/ID--22230), 64 p. #' U.S. Geological Survey Open-File Report 2014--1146 (DOE/ID--22230), 64 p.
#' \url{https://pubs.usgs.gov/of/2014/1146/}. #' <https://pubs.usgs.gov/of/2014/1146/>.
#' #'
#' Bodnar, L.Z., and Percival, D.R., eds., 1982, #' Bodnar, L.Z., and Percival, D.R., eds., 1982,
#' Analytical Chemistry Branch procedures manual---Radiological and Environmental Sciences Laboratory: #' Analytical Chemistry Branch procedures manual---Radiological and Environmental Sciences Laboratory:
#' U.S. Department of Energy Report IDO--12096 [variously paged]. #' U.S. Department of Energy Report IDO--12096 \[variously paged\].
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
#' @examples #' @examples
#' str(dl) #' str(dl)
#' "dl"
"dl" \ No newline at end of file
R/esrp.R
View file @ 62918289
...@@ -3,10 +3,10 @@ ...@@ -3,10 +3,10 @@
#' Boundary of the eastern Snake River Plain, Idaho. #' Boundary of the eastern Snake River Plain, Idaho.
#' #'
#' @format A SpatialPolygonsDataFrame of the \pkg{sp} package object with 1 feature and 1 variable. #' @format A SpatialPolygonsDataFrame of the \pkg{sp} package object with 1 feature and 1 variable.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Geological Survey #' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office} #' [Idaho National Laboratory Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office)
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
...@@ -14,5 +14,4 @@ ...@@ -14,5 +14,4 @@
#' inlmisc::PlotMap(esrp, dms.tick = TRUE) #' inlmisc::PlotMap(esrp, dms.tick = TRUE)
#' sp::plot(esrp, col = "red", add = TRUE) #' sp::plot(esrp, col = "red", add = TRUE)
#' str(esrp@data) #' str(esrp@data)
#' "esrp"
"esrp" \ No newline at end of file
R/facilities.R
View file @ 62918289
#' Idaho National Laboratory Facilities #' Idaho National Laboratory Facilities
#' #'
#' Federal research facilities at the #' Federal research facilities at the Idaho National Laboratory ([INL](https://inl.gov/)).
#' Idaho National Laboratory (\href{https://inl.gov/}{INL}).
#' #'
#' @format A SpatialPolygonsDataFrame object with 7 features and 1 variable. #' @format A SpatialPolygonsDataFrame object with 7 features and 1 variable.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Geological Survey #' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office} #' [Idaho National Laboratory Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office)
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
...@@ -15,7 +14,7 @@ ...@@ -15,7 +14,7 @@
#' inlmisc::PlotMap(facilities, dms.tick = TRUE) #' inlmisc::PlotMap(facilities, dms.tick = TRUE)
#' sp::plot(facilities, col = "red", add = TRUE) #' sp::plot(facilities, col = "red", add = TRUE)
#' raster::text(facilities, facilities@data$NAME, #' raster::text(facilities, facilities@data$NAME,
#' cex = 0.6, pos = 1) #' cex = 0.6, pos = 1
#' )
#' str(facilities@data) #' str(facilities@data)
#' "facilities"
"facilities" \ No newline at end of file
R/gwl.R
View file @ 62918289
...@@ -3,17 +3,16 @@ ...@@ -3,17 +3,16 @@
#' Groundwater level measurements in wells in the #' Groundwater level measurements in wells in the
#' U.S. Geological Survey (USGS) water-level aquifer monitoring network, #' U.S. Geological Survey (USGS) water-level aquifer monitoring network,
#' Idaho National Laboratory and vicinity, Idaho. #' Idaho National Laboratory and vicinity, Idaho.
#' Data was obtained from the National Water Information System #' Data was obtained from the National Water Information System (NWIS) (U.S. Geological Survey, 2020).
#' (\doi{10.5066/F7P55KJN}{NWIS}) (U.S. Geological Survey, 2020).
#' #'
#' @format A data frame with 54,417 records and 5 variables: #' @format A data frame with 5 variables:
#' \describe{ #' \describe{
#' \item{\code{site_no}}{USGS site number} #' \item{`site_no`}{USGS site number}
#' \item{\code{lev_dt}}{date the water level was measured.} #' \item{`lev_dt`}{date the water level was measured.}
#' \item{\code{lev_va}}{water level value, in feet below land surface. #' \item{`lev_va`}{water level value, in feet below land surface.
#' A water-level elevation may be calculated by subtracting the depth-to-water #' A water-level elevation may be calculated by subtracting the depth-to-water
#' (\code{lev_va}) from the land-surface elevation (\code{alt_va} in the \code{\link{sites}} dataset).} #' (`lev_va`) from the land-surface elevation (`alt_va` in the [`sites`] dataset).}
#' \item{\code{lev_status_cd}}{a code indicating the status of the site #' \item{`lev_status_cd`}{a code indicating the status of the site
#' at the time the water level was measured. #' at the time the water level was measured.
#' The codes and their meanings are: #' The codes and their meanings are:
#' "A" water level was affected by atmospheric pressure, #' "A" water level was affected by atmospheric pressure,
...@@ -24,8 +23,8 @@ ...@@ -24,8 +23,8 @@
#' "R" the site had been pumped recently, #' "R" the site had been pumped recently,
#' "S" a nearby site that taps the same aquifer was being pumped, and #' "S" a nearby site that taps the same aquifer was being pumped, and
#' "X" the water level was affected by stage in nearby surface-water site.} #' "X" the water level was affected by stage in nearby surface-water site.}
#' \item{\code{date_time}}{date and time the water level was measured. #' \item{`date_time`}{date and time the water level was measured.
#' Missing values of time were substituted with \dQuote{00:00} (12:00 midnight and start of day).} #' Missing values of time were substituted with "00:00" (12:00 midnight and start of day).}
#' } #' }
#' #'
#' @source Data obtained from the NWIS database (U.S. Geological Survey, 2020). #' @source Data obtained from the NWIS database (U.S. Geological Survey, 2020).
...@@ -36,26 +35,33 @@ ...@@ -36,26 +35,33 @@
#' @keywords datasets #' @keywords datasets
#' #'
#' @examples #' @examples
#' site_no <- "432700112470801" # well USGS 1 #' site_no <- "432700112470801" # well USGS 1
#' xlim <- as.Date(c("1989-01-01", "2019-01-01")) #' xlim <- as.Date(c("1989-01-01", "2019-01-01"))
#' d <- gwl[gwl$site_no == site_no, c("lev_dt", "lev_va")] #' d <- gwl[gwl$site_no == site_no, c("lev_dt", "lev_va")]
#' main <- sites@data[sites@data$site_no == site_no, "site_nm"] #' main <- sites@data[sites@data$site_no == site_no, "site_nm"]
#' ylab <- sprintf("Water level, in %s below land surface", #' ylab <- sprintf(
#' c("feet", "meters")) #' "Water level, in %s below land surface",
#' inlmisc::PlotGraph(d, ylab = ylab, main = main, xlim = xlim, #' c("feet", "meters")
#' type = "p", pch = 19, seq.date.by = "year", #' )
#' conversion.factor = 0.3048, #' inlmisc::PlotGraph(d,
#' center.date.labels = TRUE) #' ylab = ylab, main = main, xlim = xlim,
#' type = "p", pch = 19, seq.date.by = "year",
#' conversion.factor = 0.3048,
#' center.date.labels = TRUE
#' )
#' str(gwl) #' str(gwl)
#' #'
#' alt_va <- sites@data[sites@data$site_no == site_no, "alt_va"] #' alt_va <- sites@data[sites@data$site_no == site_no, "alt_va"]
#' y <- alt_va - d$lev_va #' y <- alt_va - d$lev_va
#' ylab <- sprintf("Water level, in %s above sea level", #' ylab <- sprintf(
#' c("feet", "meters")) #' "Water level, in %s above sea level",
#' inlmisc::PlotGraph(d$lev_dt, y, ylab = ylab, main = main, #' c("feet", "meters")
#' xlim = xlim, type = "p", pch = 19, #' )
#' seq.date.by = "year", #' inlmisc::PlotGraph(d$lev_dt, y,
#' conversion.factor = 0.3048, #' ylab = ylab, main = main,
#' center.date.labels = TRUE) #' xlim = xlim, type = "p", pch = 19,
#' #' seq.date.by = "year",
"gwl" #' conversion.factor = 0.3048,
#' center.date.labels = TRUE
#' )
"gwl"
\ No newline at end of file
R/idaho.R
View file @ 62918289
...@@ -4,17 +4,16 @@ ...@@ -4,17 +4,16 @@
#' a state in the northwestern region of the United States. #' a state in the northwestern region of the United States.
#' #'
#' @format A SpatialPolygons of the \pkg{sp} package with 1 feature. #' @format A SpatialPolygons of the \pkg{sp} package with 1 feature.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Department of Commerce, U.S. Census Bureau, Geography Division/Cartographic Products Branch. #' @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 #' 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), #' ([MAF/TIGER](https://catalog.data.gov/dataset/tiger-line-shapefile-2019-series-information-for-the-current-place-state-based-shapefile))
#' 2019 data collection, released April 2, 2020. #' Database (MTDB), 2019 data collection, released April 2, 2020.
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
#' @examples #' @examples
#' inlmisc::PlotMap(idaho, dms.tick = TRUE) #' inlmisc::PlotMap(idaho, dms.tick = TRUE)
#' sp::plot(idaho, col = "red", add = TRUE) #' sp::plot(idaho, col = "red", add = TRUE)
#' "idaho"
"idaho" \ No newline at end of file
R/inl.R
View file @ 62918289
#' Idaho National Laboratory Boundary #' Idaho National Laboratory Boundary
#' #'
#' Boundary of the Idaho National Laboratory (\href{https://inl.gov/}{INL}). #' Boundary of the Idaho National Laboratory ([INL](https://inl.gov/)).
#' #'
#' @format A SpatialPolygonsDataFrame of the \pkg{sp} package object with 1 feature and 4 variables. #' @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. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Geological Survey #' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office} #' [Idaho National Laboratory Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office)
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
...@@ -14,5 +14,4 @@ ...@@ -14,5 +14,4 @@
#' inlmisc::PlotMap(inl, dms.tick = TRUE) #' inlmisc::PlotMap(inl, dms.tick = TRUE)
#' sp::plot(inl, col = "red", add = TRUE) #' sp::plot(inl, col = "red", add = TRUE)
#' str(inl@data) #' str(inl@data)
#' "inl"
"inl" \ No newline at end of file
R/labels.R
View file @ 62918289
...@@ -2,27 +2,27 @@ ...@@ -2,27 +2,27 @@
#' #'
#' Map labels in the vicinity of Idaho National Laboratory, eastern Idaho. #' Map labels in the vicinity of Idaho National Laboratory, eastern Idaho.
#' #'
#' @format A SpatialPointsDataFrame of the \pkg{sp} package with 50 features and 7 variables: #' @format A SpatialPointsDataFrame of the \pkg{sp} package with multiple features and 7 variables:
#' \describe{ #' \describe{
#' \item{\code{labels}}{text to be written} #' \item{`labels`}{text to be written}
#' \item{\code{cex}}{character expansion factor} #' \item{`cex`}{character expansion factor}
#' \item{\code{col}, \code{font}}{color and font to be used, respectively.} #' \item{`col`, `font`}{color and font to be used, respectively.}
#' \item{\code{srt}}{string rotation in degrees.} #' \item{`srt`}{string rotation in degrees.}
#' \item{\code{halo}}{if true, a "halo" is printed around text.} #' \item{`halo`}{if true, a "halo" is printed around text.}
#' \item{\code{map}}{map index} #' \item{`map`}{map index}
#' } #' }
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Geological Survey #' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office} #' [Idaho National Laboratory Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office)
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
#' @examples #' @examples
#' inlmisc::PlotMap(labels, dms.tick = TRUE) #' inlmisc::PlotMap(labels, dms.tick = TRUE)
#' lab <- labels[labels$map == 1L, names(labels) != "map"] #' lab <- labels[labels$map == 1L, names(labels) != "map"]
#' for (i in seq_along(lab)) #' for (i in seq_along(lab)) {
#' do.call(raster::text, c(lab[i, ], as.list(lab@data[i, ]))) #' do.call(raster::text, c(lab[i, ], as.list(lab@data[i, ])))
#' }
#' str(labels@data) #' str(labels@data)
#' "labels"
"labels" \ No newline at end of file
R/lakes.R
View file @ 62918289
...@@ -2,8 +2,8 @@ ...@@ -2,8 +2,8 @@
#' #'
#' Perennial lakes and ponds in the vicinity of Idaho National Laboratory, eastern Idaho. #' Perennial lakes and ponds in the vicinity of Idaho National Laboratory, eastern Idaho.
#' #'
#' @format A SpatialPolygonsDataFrame of the \pkg{sp} package with 155 features of 12 variables. #' @format A SpatialPolygonsDataFrame of the \pkg{sp} package with multiple features and 12 variables.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Geological Survey (USGS), National Geospatial Technical Operations Center, #' @source U.S. Geological Survey (USGS), National Geospatial Technical Operations Center,
#' USGS National Hydrography Dataset (NHD) Medium Resolution for Idaho, #' USGS National Hydrography Dataset (NHD) Medium Resolution for Idaho,
...@@ -12,8 +12,9 @@ ...@@ -12,8 +12,9 @@
#' @keywords datasets #' @keywords datasets
#' #'
#' @examples #' @examples
#' inlmisc::PlotMap(lakes, dms.tick = TRUE, #' inlmisc::PlotMap(lakes,
#' lakes = list(lakes, "lwd" = 1)) #' dms.tick = TRUE,
#' lakes = list(lakes, "lwd" = 1)
#' )
#' str(lakes@data) #' str(lakes@data)
#' "lakes"
"lakes" \ No newline at end of file
R/mountains.R
View file @ 62918289
...@@ -3,11 +3,11 @@ ...@@ -3,11 +3,11 @@
#' Simplified representation of the mountain ranges and buttes in the #' Simplified representation of the mountain ranges and buttes in the
#' vicinity of Idaho National Laboratory, eastern Idaho. #' vicinity of Idaho National Laboratory, eastern Idaho.
#' #'
#' @format A SpatialPolygonsDataFrame of the \pkg{sp} package with 17 features and 1 variable. #' @format A SpatialPolygonsDataFrame of the \pkg{sp} package with multiple features and 1 variable.
#' See \code{\link{projection}} dataset for coordinate reference system information. #' See [`projection`] dataset for coordinate reference system information.
#' #'
#' @source U.S. Geological Survey #' @source U.S. Geological Survey
#' \href{https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office}{Idaho National Laboratory Project Office} #' [Idaho National Laboratory Project Office](https://www.usgs.gov/centers/id-water/science/idaho-national-laboratory-project-office)
#' #'
#' @keywords datasets #' @keywords datasets
#' #'
...@@ -15,5 +15,4 @@ ...@@ -15,5 +15,4 @@
#' inlmisc::PlotMap(mountains, dms.tick = TRUE) #' inlmisc::PlotMap(mountains, dms.tick = TRUE)
#' sp::plot(mountains, col = "gray", add = TRUE) #' sp::plot(mountains, col = "gray", add = TRUE)
#' str(mountains@data) #' str(mountains@data)
#' "mountains"
"mountains" \ No newline at end of file
R/parameters.R
View file @ 62918289
...@@ -5,28 +5,29 @@ ...@@ -5,28 +5,29 @@
#' wells in the U.S. Geological Survey (USGS) water-quality aquifer monitoring network, #' wells in the U.S. Geological Survey (USGS) water-quality aquifer monitoring network,
#' Idaho National Laboratory and vicinity, Idaho. #' Idaho National Laboratory and vicinity, Idaho.
#' #'
#' @format A data frame with 74 records and 7 variables: #' @format A data frame with 7 variables:
#' \describe{ #' \describe{
#' \item{\code{parm_cd}}{USGS 5-digit parameter code} #' \item{`parm_cd`}{USGS 5-digit parameter code}
#' \item{\code{parameter_group_nm}}{parameter group name, such as \code{"Radiochemical"}} #' \item{`parameter_group_nm`}{parameter group name, such as `"Radiochemical"`}
#' \item{\code{parameter_nm}}{long parameter name, such as \code{"Strontium-90, water, unfiltered, picocuries per liter"}} #' \item{`parameter_nm`}{long parameter name,
#' \item{\code{casrn}}{Chemical Abstracts Service #' such as `"Strontium-90, water, unfiltered, picocuries per liter"`}
#' (\href{https://www.cas.org/support/documentation/chemical-substances/faqs}{CAS}) registry number, #' \item{`casrn`}{Chemical Abstracts Service
#' such as \code{"10098-97-2"} for Strontium-90} #' ([CAS](https://www.cas.org/support/documentation/chemical-substances/faqs)) registry number,
#' \item{\code{srsname}}{Substance Registry Services #' such as `"10098-97-2"` for Strontium-90}
#' (\href{https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do}{SRS}) name, #' \item{`srsname`}{Substance Registry Services
#' such as \code{"Strontium-90"}} #' ([SRS](https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do)) name,
#' \item{\code{parameter_units}}{parameter units. #' such as `"Strontium-90"`}
#' \item{`parameter_units`}{parameter units.
#' Unit abbreviations and descriptions are: #' Unit abbreviations and descriptions are:
#' \code{"mg/L"} milligrams per liter, #' `"mg/L"` milligrams per liter,
#' \code{"mg/L as N"} milligrams per liter as Nitrogen, #' `"mg/L as N"` milligrams per liter as Nitrogen,
#' \code{"ug/L"} microgram per liter, and #' `"ug/L"` microgram per liter, and
#' \code{"pCi/L"} picocuries per liter.} #' `"pCi/L"` picocuries per liter.}
#' \item{\code{siunitx}}{parameter units formatted for LaTeX using the \code{siunitx} package notation.} #' \item{`siunitx`}{parameter units formatted for LaTeX using the `siunitx` package notation.}
#' } #' }
#' #'
#' @source USGS water data acquired from the National Water Information System (U.S. Geological Survey, 2019). #' @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}) #' The [SRS](https://iaspub.epa.gov/sor_internet/registry/substreg/home/overview/home.do) name (`srsname`)
#' for "Trihalomethanes (four), total, from SDWA NPDWR" was shorten to its preferred acronym "TTHM4".