Skip to content

Commit bc5d177

Browse files
committed
update documentation with lookup tables
1 parent 198c132 commit bc5d177

1 file changed

Lines changed: 17 additions & 9 deletions

File tree

dataretrieval/samples.py

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,8 @@ def get_USGS_samples(
264264
organizations - "organization", "count"
265265
activityMediaName : string or list of strings, optional
266266
Name or code indicating environmental medium in which sample was taken.
267+
Check the `activityMediaName_lookup()` function in this module for all
268+
possible inputs.
267269
Example: "Water".
268270
activityStartDateLower : string, optional
269271
The start date if using a date range. Takes the format YYYY-MM-DD.
@@ -280,10 +282,13 @@ def get_USGS_samples(
280282
Example: "Sample-Routine, regular".
281283
characteristicGroup : string or list of strings, optional
282284
Characteristic group is a broad category of characteristics
283-
describing one or more results.
285+
describing one or more results. Check the `characteristicGroup_lookup()`
286+
function in this module for all possible inputs.
284287
Example: "Organics, PFAS"
285288
characteristic : string or list of strings, optional
286289
Characteristic is a specific category describing one or more results.
290+
Check the `characteristic_lookup()` function in this module for all
291+
possible inputs.
287292
Example: "Suspended Sediment Discharge"
288293
characteristicUserSupplied : string or list of strings, optional
289294
A user supplied characteristic name describing one or more results.
@@ -303,23 +308,27 @@ def get_USGS_samples(
303308
countryFips : string or list of strings, optional
304309
Example: "US" (United States)
305310
stateFips : string or list of strings, optional
306-
Check out the code service for FIPS codes:
307-
https://api.waterdata.usgs.gov/samples-data/codeservice/docs#/
311+
Check the `stateFips_lookup()` function in this module for all
312+
possible inputs.
308313
Example: "US:15" (United States: Hawaii)
309314
countyFips : string or list of strings, optional
310-
Check out the code service for FIPS codes:
311-
https://api.waterdata.usgs.gov/samples-data/codeservice/docs#/
315+
Check the `countyFips_lookup()` function in this module for all
316+
possible inputs.
312317
Example: "US:15:001" (United States: Hawaii, Hawaii County)
313318
siteTypeCode : string or list of strings, optional
314-
An abbreviation for a certain site type.
319+
An abbreviation for a certain site type. Check the `siteType_lookup()`
320+
function in this module for all possible inputs.
315321
Example: "GW" (Groundwater site)
316322
siteTypeName : string or list of strings, optional
317-
A full name for a certain site type.
323+
A full name for a certain site type. Check the `siteType_lookup()`
324+
function in this module for all possible inputs.
318325
Example: "Well"
319326
usgsPCode : string or list of strings, optional
320327
5-digit number used in the US Geological Survey computerized
321328
data system, National Water Information System (NWIS), to
322-
uniquely identify a specific constituent
329+
uniquely identify a specific constituent. Check the
330+
`characteristic_lookup()` function in this module for all possible
331+
inputs.
323332
Example: "00060" (Discharge, cubic feet per second)
324333
hydrologicUnit : string or list of strings, optional
325334
Max 12-digit number used to describe a hydrologic unit.
@@ -347,7 +356,6 @@ def get_USGS_samples(
347356
recordIdentifierUserSupplied : string or list of strings, optional
348357
Internal AQS record identifier that returns 1 entry. Only available
349358
for the "results" service.
350-
mimeType : string, optional
351359
352360
Returns
353361
-------

0 commit comments

Comments
 (0)