-
Notifications
You must be signed in to change notification settings - Fork 6
/
data.R
1831 lines (1771 loc) · 72.7 KB
/
data.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#' Extent of Alluvium Unit
#'
#' Estimated extent of alluvium unit in the Wood River Valley aquifer system.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 1 Polygons.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Extent defined by Bartollino and Adkins (2012, Plate 1).
#'
#' @references Bartolino, J.R., and Adkins, C.B., 2012,
#' Hydrogeologic framework of the Wood River Valley aquifer system, south-central Idaho:
#' U.S. Geological Survey Scientific Investigations Report 2012-5053, 46 p.,
#' available at \url{https://pubs.usgs.gov/sir/2012/5053/}.
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(alluvium.extent, col = "#BFA76F")
#' str(alluvium.extent)
#'
"alluvium.extent"
#' Thickness of the Quaternary Sediment
#'
#' Estimated thickness of the Quaternary sediment in the Wood River Valley aquifer system.
#'
#' @format An object of RasterLayer class.
#' Each cell on the surface grid represents a depth measured from land surface in meters.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#' The spatial grid is composed of 565 rows and 429 columns,
#' and has cell sizes that are constant at 100 meters by 100 meters.
#'
#' @source Revised version of Plate 1 in Bartolino and Adkins (2012).
#'
#' @references Bartolino, J.R., and Adkins, C.B., 2012,
#' Hydrogeologic framework of the Wood River Valley aquifer system, south-central Idaho:
#' U.S. Geological Survey Scientific Investigations Report 2012-5053, 46 p.,
#' available at \url{https://pubs.usgs.gov/sir/2012/5053/}.
#'
#' @keywords datasets
#'
#' @examples
#' col <- rainbow(255, start = 0.0, end = 0.8)
#' raster::image(alluvium.thickness, col = col, asp = 1, axes = FALSE,
#' xlab = "", ylab = "")
#' summary(alluvium.thickness)
#'
"alluvium.thickness"
#' Extent of Basalt Unit
#'
#' Estimated extent of the basalt unit underlying the alluvial Wood River Valley aquifer system.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 1 Polygons.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Extent defined by Bartollino and Adkins (2012, Plate 1).
#'
#' @references Bartolino, J.R., and Adkins, C.B., 2012,
#' Hydrogeologic framework of the Wood River Valley aquifer system, south-central Idaho:
#' U.S. Geological Survey Scientific Investigations Report 2012-5053, 46 p.,
#' available at \url{https://pubs.usgs.gov/sir/2012/5053/}.
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(basalt.extent, col = "#BEAED4", border = NA)
#' sp::plot(alluvium.extent, add = TRUE)
#' str(basalt.extent)
#'
"basalt.extent"
#' Bellevue Waste Water Treatment Plant Ponds
#'
#' Location of the Bellevue Waste Water Treatment Plant ponds.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 1 Polygons.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources, accessed on December 11, 2014
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(bellevue.wwtp.ponds)
#'
"bellevue.wwtp.ponds"
#' Bypass Canal
#'
#' Location of the Bypass Canal in the Wood River Valley.
#'
#' @format An object of SpatialLines class containing 4 Lines.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources, accessed on January 15, 2015
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(bypass.canal)
#'
"bypass.canal"
#' Canal Seepage
#'
#' Canal seepage as a fraction of diversions for irrigation entities in the Wood River Valley.
#'
#' @format An object of class data.frame with 19 records and the following variables:
#' \describe{
#' \item{EntityName}{name of the irrigation entity served by the canal system.}
#' \item{SeepFrac}{estimated canal seepage as a fraction of diversions.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on November 4, 2015
#'
#' @seealso \code{\link{canals}}
#'
#' @keywords datasets
#'
#' @examples
#' str(canal.seep)
#'
#' d <- canal.seep[order(canal.seep$SeepFrac, decreasing=TRUE), ]
#' par(mar = c(4.1, 8.1, 0.1, 0.6))
#' barplot(d$SeepFrac, names.arg = d$EntityName, horiz = TRUE, cex.names = 0.7,
#' cex.axis = 0.7, cex.lab = 0.7, las = 1, xlab = "Seepage fraction")
#'
#' graphics.off()
#'
"canal.seep"
#' Canal Systems
#'
#' Canal systems in the Wood River Valley and surrounding areas.
#'
#' @format An object of SpatialLinesDataFrame class containing
#' 113 Lines and a data.frame with the following variable:
#' \describe{
#' \item{EntityName}{name of the irrigation entity served by the canal system.}
#' \item{Name}{local canal name}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on November 29, 2014
#'
#' @seealso \code{\link{r.canals}}, \code{\link{canal.seep}}
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(canals, col = "#3399CC")
#' str(canals@data)
#'
"canals"
#' Cities and Towns
#'
#' Cities and towns in the Wood River Valley and surrounding areas.
#'
#' @format An object of SpatialPointsDataFrame class containing 11 points.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources
#' (\href{https://research.idwr.idaho.gov/index.html#GIS-Data}{IDWR}),
#' accessed on April 15, 2015
#'
#' @keywords datasets
#'
#' @examples
#' str(cities)
#'
#' col <- "#333333"
#' sp::plot(cities, pch = 15, cex = 0.8, col = col)
#' text(cities, labels = cities@data$FEATURE_NA, col = col, cex = 0.5, pos = 1, offset = 0.4)
#'
"cities"
#' Extent of Clay Unit
#'
#' Estimated extent of the clay confining unit (aquitard) separating the
#' unconfined aquifer from the underlying confined aquifer in the
#' Wood River Valley aquifer system.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 2 Polygons.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Extent defined by Moreland (1977, fig. 3 in USGS Open-File report).
#' Moreland (1977) shows an outlier by Picabo that is assumed to
#' indicate confined conditions in the basalt and not the lake sediments.
#'
#' @references Moreland, J.A., 1977, Ground water-surface water relations in the Silver Creek area,
#' Blaine County, Idaho: Boise, Idaho Department of Water Resources, Water Information Bulletin 44,
#' 42 p., 5 plates in pocket, accessed January 31, 2012.
#' Also published as U.S. Geological Survey Open-File report 77-456, 66 p.,
#' available at \url{https://pubs.er.usgs.gov/publication/ofr77456}.
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(clay.extent, col = "#FDC086", border = NA)
#' sp::plot(alluvium.extent, add = TRUE)
#' str(clay.extent)
#'
"clay.extent"
#' Combined Surface-Water Irrigation Diversions
#'
#' Supplemental groundwater rights and associated surface-water rights.
#'
#' @format An object of class data.frame with 1,213 records and the following variables:
#' \describe{
#' \item{WaterRight}{name of the supplemental groundwater right.}
#' \item{CombWaterRight}{name of the surface-water right that shares a
#' combined limit with the groundwater right.}
#' \item{Source}{river or stream source name for the surface-water right.}
#' \item{WaterUse}{authorized beneficial use for the surface-water right.}
#' \item{MaxDivRate}{authorized maximum diversion rate for the surface-water right,
#' in cubic meters per day.}
#' \item{Pdate}{priority date of the surface-water right.}
#' }
#'
#' @source Idaho Department of Water Resources (IDWR), accessed on April 25, 2014;
#' derived from combined limit comments in IDWR water rights database.
#'
#' @keywords datasets
#'
#' @examples
#' str(comb.sw.irr)
#'
"comb.sw.irr"
#' Groundwater Diversions
#'
#' Groundwater diversions recorded by Water District 37 or municipal water providers.
#' Groundwater is diverted from the aquifer by means of either pumping wells or
#' flowing-artesian wells.
#'
#' @format An object of class data.frame with 7,292 records and the following variables:
#' \describe{
#' \item{YearMonth}{year and month during which diversions were recorded,
#' with a required date format of YYYYMM.}
#' \item{Diversion}{name of the well}
#' \item{Reach}{name of the river subreach into which the well water is discharged;
#' only applicable to exchange wells.}
#' \item{BigReach}{name of the river reach into which the well water is discharged;
#' only applicable to exchange wells.}
#' \item{EntityName}{name of the irrigation entity which the well supplies water.}
#' \item{WMISNumber}{well number in the Idaho Department of Water Resources (IDWR)
#' Water Measurement Information System.}
#' \item{GWDiv}{volume of water diverted during the month, in cubic meters.}
#' }
#'
#' @source Idaho Department of Water Resources (IDWR), accessed on December 11, 2014;
#' compiled data records from Water District 37 and 37M, City of Ketchum,
#' Sun Valley Water and Sewer District, City of Hailey, and City of Bellevue.
#'
#' @keywords datasets
#'
#' @examples
#' str(div.gw)
#'
"div.gw"
#' Diversions, Returns, and Exchange Wells
#'
#' Location of streamflow diversions, irrigation canal or pond returns, and
#' exchange well returns.
#'
#' @format An object of SpatialPointsDataFrame class containing 117 points with the
#' following variables:
#' \describe{
#' \item{Name}{local name for the diversion/return site.}
#' \item{Type}{data type, either \dQuote{Diversion}, \dQuote{Return}, or
#' \dQuote{Exchange well inflow}.}
#' \item{LocSource}{data source}
#' \item{Big}{corresponding river reach}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources, accessed on June 5, 2015
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(div.ret.exch)
#' str(div.ret.exch@data)
#'
"div.ret.exch"
#' Surface-Water Diversions
#'
#' Surface-water diversions recorded by Water District 37 or municipal water providers.
#'
#' @format An object of class data.frame with 15,550 records and the following variables:
#' \describe{
#' \item{YearMonth}{year and month during which diversions were recorded,
#' with a required date format of YYYYMM.}
#' \item{Diversion}{name of the surface-water diversion.}
#' \item{Reach}{river subreach from which the water is diverted.}
#' \item{BigReach}{river reach from which the water is diverted.}
#' \item{EntityName}{name of the irrigation entity which the diversion supplies water.}
#' \item{SWDiv}{volume of water diverted during the month, in cubic meters.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on December 11, 2014;
#' compiled data records from Water District 37 and 37M, City of Hailey,
#' City of Bellevue, City of Ketchum, and Sun Valley Water and Sewer District.
#'
#' @keywords datasets
#'
#' @examples
#' str(div.sw)
#'
"div.sw"
#' Wastewater Treatment Plant Diversions
#'
#' Discharge from wastewater treatment plants.
#'
#' @format An object of class data.frame with 1,182 records and the following variables:
#' \describe{
#' \item{YearMonth}{year and month during which diversions were recorded,
#' with a required date format of YYYYMM.}
#' \item{Return}{name of the wastewater treatment plant.}
#' \item{Reach}{name of the river subreach to which treated effluent is discharged;
#' only applicable to wastewater treatment plants that discharge to the river.}
#' \item{BigReach}{name of the river reach to which treated effluent is discharged;
#' only applicable to wastewater treatment plants that discharge to the river.}
#' \item{EntityName}{name of the irrigation entity served by the wastewater treatment plant.}
#' \item{WWDiv}{volume of wastewater discharged during the month, in cubic meters.}
#' }
#'
#' @source Idaho Department of Water Resources and U.S. Geological Survey,
#' accessed on August 11, 2014; compiled data records from the
#' U.S. Environmental Protection Agency for plants that discharge to the river,
#' and from records of the Idaho Department of Environmental Quality for
#' plants that discharge to land application.
#'
#' @keywords datasets
#'
#' @examples
#' str(div.ww)
#'
"div.ww"
#' Drain Boundaries at Stanton Crossing and Silver Creek
#'
#' Polygons used to define the locations of drain boundaries in the model domain.
#' The polygons clip the line segments along the aquifer boundary (see \code{\link{alluvium.extent}}),
#' and model cells intersecting these clipped-line segments are defined as boundary cells.
#'
#' @format An object of SpatialPolygonsDataFrame class containing a set of 2 Polygons and
#' a data.frame with the following variable:
#' \describe{
#' \item{Name}{identifier for the polygon.}
#' \item{cond}{drain conductance in square meters per day.}
#' \item{elev}{drain threshold elevation in meters above the
#' North American Vertical Datum of 1988 (NAVD 88).}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source U.S. Geological Survey, accessed on March 27, 2015;
#' a Keyhole Markup Language (\href{https://en.wikipedia.org/wiki/Kml}{KML}) file created in
#' \href{https://www.google.com/earth/}{Google Earth} with polygons drawn by hand in
#' areas of known drains.
#'
#' @keywords datasets
#'
#' @examples
#' str(drains)
#'
#' sp::plot(drains, border = "red")
#' sp::plot(alluvium.extent, add = TRUE)
#'
"drains"
#' Dry River Bed and Stream Fed Creek Conditions
#'
#' A summary of dry river bed and stream fed conditions in the Wood River Valley, Idaho.
#' Stream reaches on the Big Wood River between Glendale and Wood River Ranch are episodically dry;
#' these dry periods are specified for calendar months when water diversions to the
#' Bypass Canal begins before the 16th of the month and ends after the 15th of the month.
#'
#' @format An object of data.frame class with 12 records and the following variables:
#' \describe{
#' \item{Reach}{stream reach name}
#' \item{199501,\dots,201012}{logical values indicating whether the stream reach exhibits
#' dry-bed conditions during a stress period.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on January 6, 2016;
#' compiled from Water District 37 records.
#'
#' @keywords datasets
#'
#' @examples
#' str(drybed)
#'
"drybed"
#' Irrigation Efficiency
#'
#' The irrigation efficiency of irrigation entities in the Wood River Valley, Idaho.
#'
#' @format An object of data.frame class with 88 records and the following variables:
#' \describe{
#' \item{EntityName}{name of the irrigation entity which the irrigation efficiency is applied.}
#' \item{Eff}{estimated irrigation efficiency, the ratio of the amount of
#' water consumed by the crop to the amount of water supplied through irrigation.}
#' \item{Comment}{brief comment on irrigation conditions.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on July 9, 2015
#'
#' @keywords datasets
#'
#' @examples
#' str(efficiency)
#'
"efficiency"
#' Irrigation Entity Components
#'
#' Irrigation entities and their components in the Wood River Valley and surrounding areas.
#' An irrigation entity is defined as an area served by a group of surface-water and/or
#' groundwater diversion(s).
#'
#' @format An object of list class with components of SpatialPolygonsDataFrame-class.
#' There are a total of 192 components, one for each month in the 1995--2010 time period.
#' Linked data.frame objects have the following variables:
#' \describe{
#' \item{EntitySrce}{concatenation of the \code{EntityName} and \code{Source} character strings.}
#' \item{mean.et}{mean evapotranspiration (ET) on irrigated and semi-irrigated lands in meters.}
#' \item{area}{area of irrigated and semi-irrigated lands in square meters.}
#' \item{PrecipZone}{name of the precipitation zone;
#' see \code{\link{precip.zones}} dataset for details.}
#' \item{et.vol}{volume of ET on irrigated and semi-irrigated lands in cubic meters.}
#' \item{precip.vol}{volume of precipitation on irrigated and semi-irrigated lands in cubic meters.}
#' \item{cir.vol}{volume of crop irrigation requirement in cubic meters (ET minus precipitation).}
#' \item{EntityName}{name of the irrigation entity.}
#' \item{Source}{water source, either \dQuote{Mixed} for a mixture of surface water and groundwater,
#' \dQuote{SW Only} for surface water only, or \dQuote{GW Only} for groundwater only.}
#' }
#'
#' @source Calculated from the \code{\link{irr.entities}}, \code{\link{wetlands}},
#' \code{\link{public.parcels}}, \code{\link{irr.lands.year}}, \code{\link{et}}, and
#' \code{\link{precipitation}} datasets;
#' see the \file{package-datasets} vignette for the \R code used in this calculation.
#'
#' @keywords datasets
#'
#' @examples
#' names(entity.components)
#' sp::plot(entity.components[["199506"]])
#' print(entity.components[["199506"]])
#'
"entity.components"
#' Evapotranspiration
#'
#' Evapotranspiration (ET) in the Wood River Valley and surrounding areas.
#' Defined as the amount of water lost to the atmosphere via direct evaporation,
#' transpiration by vegetation, or sublimation from snow covered areas.
#'
#' @format An object of RasterStack class containing 192 RasterLayer objects,
#' one layer for each month in the 1995-2010 time period.
#' Each cell on a layers surface grid represents the monthly depth of ET in meters.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources, accessed on November 17, 2014
#'
#' @seealso \code{\link{et.method}}
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(et[["199505"]])
#' print(et)
#'
"et"
#' Method Used to Calculate Evapotranspiration
#'
#' Methods used to estimate monthly distributions of evapotranspiration (ET) rate.
#'
#' @format An object of data.frame class with 122 records with the following variables:
#' \describe{
#' \item{YearMonth}{year and month during which the method was applied,
#' with a required date format of YYYYMM.}
#' \item{ETMethod}{Identifier that indicates the method used to estimate ET values.
#' Identifiers include either
#' \dQuote{Allen-Robison}, the Allen and Robison method (Allen and Robison, 2007);
#' \dQuote{METRIC}, the Mapping Evapotranspiration at high Resolution and with
#' Internalized Calibration (METRIC) model (Allen and others, 2010a);
#' \dQuote{NDVI}, the Normalized Difference Vegetation Index (NDVI) method
#' (Allen and others, 2010b);
#' \dQuote{Interpolation}, interpolation from known ET data; or
#' \dQuote{METRIC-NDVI}, a combination of METRIC and NDVI methods.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on April 27, 2015
#'
#' @references Allen, R., and Robison, C.W., 2007, Evapotranspiration and
#' consumptive water requirements for Idaho, University of Idaho, Kimberly, Idaho.
#'
#' Allen, R., Tasumi, M., Trezza, R., and Kjaersgaard, J., 2010a,
#' METRIC mapping evapotranspiration at high resolution applications manual for
#' Landsat satellite imagery version 2.07, University of Idaho, Kimberly, ID.
#'
#' Allen, R., Robison, C.W., Garcia, M., Trezza, R., Tasumi, M., and Kjaersgaard, J., 2010b,
#' ETrF vs NDVI relationships for southern Idaho for rapid estimation of evapotranspiration,
#' University of Idaho, Kimberly, ID.
#'
#' ET Idaho: \url{http://data.kimberly.uidaho.edu/ETIdaho/}
#'
#' @keywords datasets
#'
#' @examples
#' str(et.method)
#'
"et.method"
#' Daily Mean Discharge at Streamgages
#'
#' The daily mean discharge at streamgages in the Big Wood River Valley, Idaho.
#' Discharge records bracket the 1992-2014 time period and are based on
#' records with quality assurance code of approved (\sQuote{A}).
#'
#' @format An object of data.frame class with 8,315 records and the following variables:
#' \describe{
#' \item{Date}{date during which discharge was averaged.}
#' \item{13135500}{daily mean discharge in cubic meters per day, recorded at the USGS
#' \href{https://waterdata.usgs.gov/id/nwis/uv/?site_no=13135500}{13135500}
#' Big Wood River near Ketchum streamgage.}
#' \item{13139510}{daily mean discharge in cubic meters per day, recorded at the USGS
#' \href{https://waterdata.usgs.gov/id/nwis/uv/?site_no=13139510}{13139510}
#' Big Wood River at Hailey streamgage.}
#' \item{13140800}{daily mean discharge in cubic meters per day, recorded at the USGS
#' \href{https://waterdata.usgs.gov/id/nwis/uv/?site_no=13140800}{13140800}
#' Big Wood River at Stanton Crossing near Bellevue streamgage.}
#' }
#'
#' @source National Water Information System (\href{https://waterdata.usgs.gov/nwis}{NWIS}),
#' accessed on January 8, 2015
#'
#' @keywords datasets
#'
#' @examples
#' str(gage.disch)
#'
#' col <- c("red", "blue", "green")
#' ylab <- paste("Discharge in cubic", c("meters per day", "acre-foot per year"))
#' inlmisc::PlotGraph(gage.disch, ylab = ylab, col = col, lty = 1:3,
#' conversion.factor = 0.29611, seq.date.by = "year")
#' leg <- sprintf("USGS %s", names(gage.disch)[-1])
#' legend("topright", leg, col = col, lty = 1:3, inset = 0.02, cex = 0.7,
#' box.lty = 1, bg = "#FFFFFFE7")
#'
#' graphics.off()
#'
"gage.disch"
#' Daily Mean Gage Height at Streamgages
#'
#' The daily mean gage height at streamgages in the Big Wood River Valley, Idaho.
#' Gage height records bracket the 1987-2014 and are based on records with
#' quality assurance codes of working (\sQuote{W}), in review (\sQuote{R}), and
#' approved (\sQuote{A}).
#'
#' @format An object of data.frame class with 9,980 records and the following variables:
#' \describe{
#' \item{Date}{date during which gage height was averaged.}
#' \item{13135500}{daily mean gage height in meters, recorded at the USGS
#' \href{https://waterdata.usgs.gov/id/nwis/uv/?site_no=13135500}{13135500}
#' Big Wood River near Ketchum streamgage.}
#' \item{13139510}{daily mean gage height in meters, recorded at the USGS
#' \href{https://waterdata.usgs.gov/id/nwis/uv/?site_no=13139510}{13139510}
#' Big Wood River at Hailey streamgage.}
#' \item{13140800}{daily mean gage height in meters, recorded at the USGS
#' \href{https://waterdata.usgs.gov/id/nwis/uv/?site_no=13140800}{13140800}
#' Big Wood River at Stanton Crossing near Bellevue streamgages.}
#' }
#'
#' @source Data queried from the National Water Information System
#' (\href{https://waterdata.usgs.gov/nwis}{NWIS}) database on December 15, 2014,
#' by Ross Dickinson (USGS).
#' Records recorded on May 26-28, 1991 and March 15-22, 1995 were reassigned
#' quality assurance codes of \sQuote{I} because of assumed ice build-up.
#' Missing data at the Big Wood River near Ketchum gage was estimated using a
#' linear regression model based on recorded gage-height data at the Big Wood River at
#' Hailey and Near Ketchum streamgages.
#' Missing data at the Stanton Crossing near Bellevue gage was replaced with
#' average gage-height values recorded at this gage.
#'
#' @keywords datasets
#'
#' @examples
#' str(gage.height)
#'
#' col <- c("red", "blue", "green")
#' ylab <- paste("Gage height in", c("meters", "feet"))
#' inlmisc::PlotGraph(gage.height, ylab = ylab, col = col, lty = 1:3,
#' conversion.factor = 3.28084, seq.date.by = "year")
#' leg <- sprintf("USGS %s", names(gage.height)[-1])
#' legend("topright", leg, col = col, lty = 1:3, inset = 0.02, cex = 0.7,
#' box.lty = 1, bg = "#FFFFFFE7")
#'
#' graphics.off()
#'
"gage.height"
#' Land Surface Hill Shading
#'
#' Hill shading of the Wood River Valley and surrounding area.
#'
#' @format An object of \code{RasterLayer} class.
#' Each cell on the surface grid represents the hill shade.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#' The spatial grid is composed of 3,108 rows and 2,360 columns,
#' and has cell sizes that are constant at 20 meters by 20 meters.
#'
#' @source Calculated from the slope and aspect of the \code{\link{land.surface}} dataset
#' using the \code{terrain} and \code{hillShade} functions;
#' see the appendix C. Package Dataset Creation for the \R code used in this calculation.
#'
#' @keywords datasets
#'
#' @examples
#' raster::image(hill.shading, length(hill.shading), col = grey(0:255 / 255), asp = 1,
#' axes = FALSE, xlab = "", ylab = "")
#'
"hill.shading"
#' U.S. State of Idaho
#'
#' Boundary of Idaho, a state in the northwestern region of the United States.
#'
#' @format An object of SpatialPolygons class containing 1 Polygons.
#' Cartographic boundary at 5m (1:5,000,000) resolution.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source U.S. Department of Commerce, U.S. Census Bureau,
#' Geography Division/Cartographic Products Branch.
#' A simplified representation of the State of Idaho from the 2014 Census Bureau's
#' MAF/\href{https://www.census.gov/geo/maps-data/data/tiger.html}{TIGER} geographic database.
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(idaho, col = "#EAE2CF", border = "#BFA76F", lwd = 0.5)
#' print(idaho)
#'
"idaho"
#' Irrigation Entities
#'
#' Delineation of areas served by a group of surface-water and (or) groundwater diversions.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 235 Polygons and
#' a data.frame with the following variables:
#' \describe{
#' \item{EntityName}{name of the irrigation entity served by a group of diversions.}
#' \item{Source}{water source, either \dQuote{Mixed} for a mixture of surface water and groundwater,
#' \dQuote{SW Only} for surface-water only, or \dQuote{GW Only} for groundwater only.}
#' \item{EntitySrce}{concatenation of the \code{EntityName} and \code{Source} character strings.}
#' \item{PrecipZone}{name of the precipitation zone.
#' See \code{\link{precip.zones}} dataset for details.}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources (IDWR), accessed on December 11, 2014;
#' derived from IDWR water rights database, Blaine County tax lot data,
#' and IDWR irrigated land classification files.
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(irr.entities)
#' print(irr.entities)
#'
"irr.entities"
#' Irrigated Lands
#'
#' Classification of irrigated lands in the Wood River Valley and surrounding areas;
#' available for years 1996, 2000, 2002, 2006, 2008, 2009, and 2010.
#'
#' @format An object of list class with 7 SpatialPolygonsDataFrame components.
#' The data.frame associated with each SpatialPolygons object has the following variable:
#' \describe{
#' \item{Status}{status of land during the year reviewed,
#' either \dQuote{irrigated}, \dQuote{semi-irrigated}, or \dQuote{non-irrigated}.}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources, accessed on November 17, 2014;
#' polygons derived from U.S. Department of Agriculture Common Land Unit polygons
#' with some refinement of polygons.
#' Irrigation status interpreted using satellite imagery and aerial photography.
#'
#' @seealso \code{\link{irr.lands.year}}
#'
#' @keywords datasets
#'
#' @examples
#' sp::spplot(irr.lands[["2010"]], "Status")
#' print(irr.lands)
#'
"irr.lands"
#' Irrigation Lands for a Given Year
#'
#' Annual land classification for irrigation practices is only available for select years.
#' For missing years, this dataset provides substitute years when land-classification was
#' available (see \code{\link{irr.lands}}).
#'
#' @format An object of data.frame class with 16 records and the following variables:
#' \describe{
#' \item{Year}{year with a required date format of YYYY.}
#' \item{IL_Year}{substitute year with a required date format of YYYY.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on April 25, 2014
#'
#' @keywords datasets
#'
#' @examples
#' str(irr.lands.year)
#'
"irr.lands.year"
#' Kriging Zones
#'
#' Location of kriging zones in the Wood River Valley, used in parameter estimation.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 18 Polygons and a
#' data.frame with the following variables:
#' \describe{
#' \item{Zone}{kriging zone, interpolation in this zone is based on the
#' parameter values of pilot points located within this zone.}
#' \item{Layer}{model layer}
#' \item{Name}{local name}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources, accessed on June 11, 2015
#'
#' @seealso \code{\link{pilot.points}}
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(kriging.zones)
#' str(kriging.zones@data)
#'
"kriging.zones"
#' Lakes and Reservoirs
#'
#' Lakes and reservoirs of the Wood River Valley and surrounding areas.
#'
#' @format An object of SpatialPolygonsDataFrame class containing 55 Polygons.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources
#' (\href{https://research.idwr.idaho.gov/index.html#GIS-Data}{IDWR}),
#' accessed on April 2, 2014
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(lakes, col = "#CCFFFF", border = "#3399CC", lwd = 0.5)
#' str(lakes@data)
#'
"lakes"
#' Topography of Land Surface
#'
#' The Wood River Valley (WRV) is a geologic feature located in south-central Idaho.
#' This dataset gives the topography of the land surface in the WRV and vicinity.
#'
#' @format An object of SpatialGridDataFrame class.
#' Each cell on the surface grid represents an elevation in meters above the
#' North American Vertical Datum of 1988 (NAVD 88).
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#' The spatial grid is composed of 565 rows and 429 columns,
#' and has cell sizes that are constant at 100 meters by 100 meters.
#'
#' @source The National Map (\href{https://nationalmap.gov/elevation.html}{TNM})
#' 1/3-arc-second raster (Gesch, 2007; Gesch and others, 2002),
#' accessed on December 1, 2015.
#' This dataset can be downloaded in a Esri ArcGRID format using the
#' \href{https://viewer.nationalmap.gov/viewer/}{The National Map Viewer}.
#' 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
#' -115, -114, 43, and 44 decimal degrees, respectively.
#' Post-processing includes:
#' (1) project the values of the elevation dataset into the \code{\link{alluvium.thickness}}
#' spatial grid using bilinear interpolation, and
#' (2) set values in cells where the elevation of the alluvium bottom is missing to NA.
#'
#' @references Gesch, D.B., 2007, The National Elevation Dataset, in Maune, D., ed.,
#' Digital Elevation Model Technologies and Applications: The DEM Users Manual,
#' 2nd Edition: 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
#' raster::image(land.surface)
#' summary(land.surface)
#'
"land.surface"
#' Major Roads
#'
#' Major roads in the Wood River Valley and surrounding areas.
#'
#' @format An object of SpatialLinesDataFrame class containing 475 Lines.
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources
#' (\href{https://research.idwr.idaho.gov/index.html#GIS-Data}{IDWR}),
#' accessed on October 20, 2015
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(major.roads)
#' str(major.roads@data)
#'
"major.roads"
#' Map Labels
#'
#' Map labels in the Wood River Valley and surrounding areas.
#'
#' @format An object of SpatialPointsDataFrame class containing
#' 40 points with the following variables:
#' \describe{
#' \item{label}{text to be written.}
#' \item{cex}{character expansion factor}
#' \item{col,font}{color and font to be used, respectively.}
#' \item{srt}{string rotation in degrees.}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Best estimates of map label locations.
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(map.labels, col = "red")
#' lab <- cbind(map.labels@coords, map.labels@data)
#' for (i in seq_len(nrow(lab))) {
#' text(lab$x[i], lab$y[i], labels = lab$label[i], cex = lab$cex[i],
#' col = lab$col[i], font = lab$font[i], srt = lab$srt[i])
#' }
#'
"map.labels"
#' Miscellaneous Locations
#'
#' Miscellaneous locations in the Bellevue triangle area.
#'
#' @format An object of SpatialPointsDataFrame class containing 3 points
#' with the following variable:
#' \describe{
#' \item{label}{description of point location.}
#' }
#' Geographic coordinates are in units of meters, in conformance with the
#' North American Datum of 1983 (NAD 83), and placed in the
#' Idaho Transverse Mercator projection (\href{https://www.idwr.idaho.gov/GIS/IDTM/}{IDTM}).
#'
#' @source Idaho Department of Water Resources
#' (\href{https://research.idwr.idaho.gov/index.html#GIS-Data}{IDWR}),
#' accessed on December 23, 2015
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(misc.locations, pch = 20, col = "red")
#' text(misc.locations, labels = misc.locations@data$label, pos = 3, cex = 0.6)
#'
"misc.locations"
#' Direct Recharge from Miscellaneous Seepage Sites
#'
#' Direct recharge from miscellaneous seepage sites in the Wood River Valley, Idaho.
#'
#' @format An object of data.frame class with 2 records and the following variables:
#' \describe{
#' \item{RechSite}{name of the recharge site, see \code{\link{bellevue.wwtp.ponds}} and
#' \code{\link{bypass.canal}} datasets.}
#' \item{199501,\dots,201012}{monthly volume of recharge during a stress period, in cubic meters.
#' The variable name is specified as year and month.}
#' }
#'
#' @source Idaho Department of Water Resources, accessed on January 15, 2015
#'
#' @keywords datasets
#'
#' @examples
#' str(misc.seepage)
#'
"misc.seepage"
#' Observation Wells
#'
#' Observation wells in the Wood River Valley aquifer system.
#'
#' @format An object of SpatialPointsDataFrame class containing 776 points
#' with the following variables:
#' \describe{
#' \item{id}{unique well identifier used in this study.}
#' \item{SiteNo}{unique well identifier within the
#' National Water Information System (NWIS).}
#' \item{SITEIDIDWR}{unique well identifier within the
#' Idaho Department of Water Resources (IDWR) hydrologic database.}
#' \item{WELLNUMBER}{USGS or IDWR site name for the well.}
#' \item{PESTNAME}{unique well identifier for PEST.}
#' \item{METHODDRIL}{drilling method}
#' \item{TOTALDEPTH}{depth at which drilling stopped, in feet.}
#' \item{OPENINGMIN}{top of the screened interval, in feet.}
#' \item{OPENINGMAX}{bottom of the screened interval, in feet.}
#' \item{COMPLETION}{date on which the well drilling and construction stopped.}
#' \item{WCWELLID}{well construction well identifier.}
#' \item{ALTITUDE}{land surface elevation, in feet.}
#' \item{ALTMETHOD}{method for obtaining the land surface elevation.}
#' \item{XYMETHOD}{method of obtaining the spatial coordinates.}
#' \item{BASINNO}{basin number}
#' \item{COUNTYNAME}{Idaho county name}
#' \item{TWPRGE}{township and range the well is located in.}
#' \item{SITENAME}{local name for well.}
#' \item{desc}{description of well type.}
#' \item{TopOpen1}{depth to the top of the first open interval in a groundwater well,
#' in meters below land surface.}
#' \item{BotOpen1}{depth to the bottom of the first open interval in a groundwater well,
#' in meters below land surface.}
#' \item{TopOpen2}{not applicable}
#' \item{BotOpen2}{not applicable}
#' }
#'
#' @source Idaho Department of Water Resources well construction database,
#' accessed on June 29, 2015
#'
#' @seealso \code{\link{obs.wells.head}}
#'
#' @keywords datasets
#'
#' @examples
#' sp::plot(obs.wells)
#' str(obs.wells@data)
#'
"obs.wells"