forked from DOI-USGS/dataRetrieval
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathread_waterdata_combined_meta.R
More file actions
209 lines (207 loc) · 10.6 KB
/
Copy pathread_waterdata_combined_meta.R
File metadata and controls
209 lines (207 loc) · 10.6 KB
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
#' Get USGS Monitoring Location Metadata
#'
#' @description `r get_description("combined-metadata")`
#'
#' @export
#' @param monitoring_location_id `r get_ogc_params("combined-metadata")$monitoring_location_id`
#' Multiple monitoring_location_ids can be requested as a character vector.
#' @param agency_code `r get_ogc_params("combined-metadata")$agency_code`
#' @param agency_name `r get_ogc_params("combined-metadata")$agency_name`
#' @param monitoring_location_number `r get_ogc_params("combined-metadata")$monitoring_location_number`
#' @param monitoring_location_name `r get_ogc_params("combined-metadata")$monitoring_location_name`
#' @param district_code `r get_ogc_params("combined-metadata")$district_code`
#' @param state_name `r get_ogc_params("combined-metadata")$state_name`
#' @param county_code `r get_ogc_params("combined-metadata")$county_code`
#' @param county_name `r get_ogc_params("combined-metadata")$county_name`
#' @param country_code `r get_ogc_params("combined-metadata")$country_code`
#' @param country_name `r get_ogc_params("combined-metadata")$country_name`
#' @param state_code `r get_ogc_params("combined-metadata")$state_code`
#' @param minor_civil_division_code `r get_ogc_params("combined-metadata")$minor_civil_division_code`
#' @param site_type_code `r get_ogc_params("combined-metadata")$site_type_code`
#' @param site_type `r get_ogc_params("combined-metadata")$site_type`
#' @param hydrologic_unit_code `r get_ogc_params("combined-metadata")$hydrologic_unit_code`
#' @param basin_code `r get_ogc_params("combined-metadata")$basin_code`
#' @param altitude `r get_ogc_params("combined-metadata")$altitude`
#' @param altitude_accuracy `r get_ogc_params("combined-metadata")$altitude_accuracy`
#' @param altitude_method_code `r get_ogc_params("combined-metadata")$altitude_method_code`
#' @param altitude_method_name `r get_ogc_params("combined-metadata")$altitude_method_name`
#' @param vertical_datum `r get_ogc_params("combined-metadata")$vertical_datum`
#' @param vertical_datum_name `r get_ogc_params("combined-metadata")$vertical_datum_name`
#' @param horizontal_positional_accuracy_code `r get_ogc_params("combined-metadata")$horizontal_positional_accuracy_code`
#' @param horizontal_positional_accuracy `r get_ogc_params("combined-metadata")$horizontal_positional_accuracy`
#' @param horizontal_position_method_code `r get_ogc_params("combined-metadata")$horizontal_position_method_code`
#' @param horizontal_position_method_name `r get_ogc_params("combined-metadata")$horizontal_position_method_name`
#' @param original_horizontal_datum `r get_ogc_params("combined-metadata")$original_horizontal_datum`
#' @param original_horizontal_datum_name `r get_ogc_params("combined-metadata")$original_horizontal_datum_name`
#' @param drainage_area `r get_ogc_params("combined-metadata")$drainage_area`
#' @param contributing_drainage_area `r get_ogc_params("combined-metadata")$contributing_drainage_area`
#' @param time_zone_abbreviation `r get_ogc_params("combined-metadata")$time_zone_abbreviation`
#' @param uses_daylight_savings `r get_ogc_params("combined-metadata")$uses_daylight_savings`
#' @param construction_date `r get_ogc_params("combined-metadata")$construction_date`
#' @param aquifer_code `r get_ogc_params("combined-metadata")$aquifer_code`
#' @param national_aquifer_code `r get_ogc_params("combined-metadata")$national_aquifer_code`
#' @param aquifer_type_code `r get_ogc_params("combined-metadata")$aquifer_type_code`
#' @param well_constructed_depth `r get_ogc_params("combined-metadata")$well_constructed_depth`
#' @param hole_constructed_depth `r get_ogc_params("combined-metadata")$hole_constructed_depth`
#' @param depth_source_code `r get_ogc_params("combined-metadata")$depth_source_code`
#' @param thresholds `r get_ogc_params("combined-metadata")$thresholds`
#' @param parameter_code `r get_ogc_params("combined-metadata")$parameter_code`
#' Multiple parameter_codes can be requested as a character vector.
#' @param parameter_name `r get_ogc_params("combined-metadata")$parameter_name`
#' Multiple parameter_names can be requested as a character vector.
#' @param unit_of_measure `r get_ogc_params("combined-metadata")$unit_of_measure`
#' @param parameter_description `r get_ogc_params("combined-metadata")$parameter_description`
#' @param data_type `r get_ogc_params("combined-metadata")$data_type`
#' @param primary
#' A flag identifying if the time series is a "primary" time series. "Primary" time
#' series (which have this flag) are standard observations which undergo Bureau
#' review and approval processes. Non-primary time series, which will have missing
#' values for "primary", are provisional datasets made available to meet the need
#' for timely best science and to assist with daily operations which need
#' real-time information. Non-primary time series data are only retained by
#' this system for 120 days.
#' @param web_description `r get_ogc_params("combined-metadata")$web_description`
#' @param parent_time_series_id `r get_ogc_params("combined-metadata")$parent_time_series_id`
#' @param statistic_id `r get_ogc_params("combined-metadata")$statistic_id`
#' Multiple statistic_ids can be requested as a character vector.
#' @param computation_identifier `r get_ogc_params("combined-metadata")$computation_identifier`
#' Multiple computation_identifiers can be requested as a character vector.
#' @param computation_period_identifier `r get_ogc_params("combined-metadata")$computation_period_identifier`
#' Multiple computation_period_identifiers can be requested as a character vector.
#' @param sublocation_identifier `r get_ogc_params("combined-metadata")$sublocation_identifier`
#' @param last_modified `r get_ogc_params("combined-metadata")$last_modified`
#'
#' See also Details below for more information.
#' @param begin `r get_ogc_params("combined-metadata")$begin`
#'
#' See also Details below for more information.
#' @param end `r get_ogc_params("combined-metadata")$end`
#'
#' See also Details below for more information.
#' @param properties A vector of requested columns to be returned from the query.
#' Available options are:
#' `r dataRetrieval:::get_properties_for_docs("combined-metadata", "field_measurement_id")`.
#' The default (`NA`) will return all columns of the data.
#' @inheritParams check_arguments_api
#' @inheritParams check_arguments_non_api
#' @inherit read_waterdata_continuous details
#'
#'
#' @examplesIf is_dataRetrieval_user()
#'
#' \donttest{
#' site <- "USGS-05407000"
#' available_data_sf <- read_waterdata_combined_meta(monitoring_location_id = site)
#'
#' groundwater <- read_waterdata_combined_meta(monitoring_location_id = "USGS-375907091432201")
#'
#' date_wi_data <- read_waterdata_combined_meta(state_name = "Wisconsin",
#' county_name = "Dane County")
#'
#'
#' multi_site <- read_waterdata_combined_meta(
#' monitoring_location_id = c("USGS-451605097071701",
#' "USGS-263819081585801"),
#' parameter_code = c("62611", "72019"))
#'
#'
#' surface_water <- read_waterdata_combined_meta(
#' monitoring_location_id = c("USGS-07069000",
#' "USGS-07064000",
#' "USGS-07068000"),
#' end = "P1M",
#' parameter_code = "00060")
#'
#' hucs <- read_waterdata_combined_meta(
#' hydrologic_unit_code = c("11010008", "11010009"),
#' site_type = c("Stream", "Spring")
#' )
#'
#' site_list <- read_waterdata_combined_meta(
#' monitoring_location_id = hucs$monitoring_location_id
#' )
#'
#' # Query for instantaneous gage height data for a site in Iowa
#' sites_inst <- read_waterdata_combined_meta(
#' monitoring_location_id = "USGS-05418400",
#' parameter_code = "00065"
#' )
#'
#' # parse individual thresholds lists:
#' threshold_1 <- jsonlite::fromJSON(sites_inst$thresholds[3])
#'
#' }
read_waterdata_combined_meta <- function(
monitoring_location_id = NA_character_,
parameter_code = NA_character_,
parameter_name = NA_character_,
unit_of_measure = NA_character_,
statistic_id = NA_character_,
parameter_description = NA_character_,
data_type = NA_character_,
computation_identifier = NA_character_,
computation_period_identifier = NA_character_,
thresholds = NA_character_,
sublocation_identifier = NA_character_,
primary = NA_character_,
web_description = NA_character_,
parent_time_series_id = NA_character_,
begin = NA_character_,
end = NA_character_,
last_modified = NA_character_,
agency_code = NA_character_,
agency_name = NA_character_,
monitoring_location_number = NA_character_,
monitoring_location_name = NA_character_,
district_code = NA_character_,
country_code = NA_character_,
country_name = NA_character_,
state_code = NA_character_,
state_name = NA_character_,
county_code = NA_character_,
county_name = NA_character_,
minor_civil_division_code = NA_character_,
site_type_code = NA_character_,
site_type = NA_character_,
hydrologic_unit_code = NA_character_,
basin_code = NA_character_,
altitude = NA_character_,
altitude_accuracy = NA_character_,
altitude_method_code = NA_character_,
altitude_method_name = NA_character_,
vertical_datum = NA_character_,
vertical_datum_name = NA_character_,
horizontal_positional_accuracy_code = NA_character_,
horizontal_positional_accuracy = NA_character_,
horizontal_position_method_code = NA_character_,
horizontal_position_method_name = NA_character_,
original_horizontal_datum = NA_character_,
original_horizontal_datum_name = NA_character_,
drainage_area = NA_character_,
contributing_drainage_area = NA_character_,
time_zone_abbreviation = NA_character_,
uses_daylight_savings = NA_character_,
construction_date = NA_character_,
aquifer_code = NA_character_,
national_aquifer_code = NA_character_,
aquifer_type_code = NA_character_,
well_constructed_depth = NA_character_,
hole_constructed_depth = NA_character_,
depth_source_code = NA_character_,
properties = NA_character_,
skipGeometry = NA,
bbox = NA,
...,
convertType = getOption("dataRetrieval.convertType"),
limit = getOption("dataRetrieval.limit"),
no_paging = getOption("dataRetrieval.no_paging"),
chunk_size = getOption("dataRetrieval.site_chunk_size_meta"),
attach_request = getOption("dataRetrieval.attach_request")
) {
service <- "combined-metadata"
output_id <- "combined_meta_id"
rlang::check_dots_empty()
args <- mget(names(formals()))
return_list <- get_ogc_data(args, output_id, service)
return(return_list)
}