siteFinder: Filter environmental monitoring stations (wrapper)

Description Usage Arguments Value Author(s) See Also Examples

View source: R/siteFinder.R

Description

A wrapper function comprising all filtering functions within the metScanR package. The metScanR database contains metadata from roughly 107,000 stations among ~200 countries/territories and ~18 networks/platforms, worldwide. This function returns metadata for a subset of those stations, based on the criteria specified by a user.

Usage

1
2
3
siteFinder(country, siteID, lat, lon, radius, network, vars, startVarsDate,
  endVarsDate, id, startDate, endDate, includeUnk, elevMin, elevMax, territory,
  ...)

Arguments

country

(character) Country(ies)/territory(ies) to filter environmental stations. See '?getCountry' for more information.

siteID

(character) in the form of: *idType:id*. Environmental monitoring network to use as your Point of Interest (POI). See '?getNearby' for more help.

lat

(numeric) Latitude of (POI). See '?getNearby' for more help.

lon

(numeric) Longitude of (POI). See '?getNearby' for more help.

radius

(numeric) Search radius outward from POI for finding environmental monitoring stations. Defined in kilometers (km). See '?getNearby' for more help

network

(character) Network(s)/platform(s) to filter environmental monitoring stations. Metadata are available for stations in the networks below. See '?getNetwork' for more information.

vars

(character) Elements(s)/variables(s) of interest. The user can search for general, environmental terms, such as 'temperature,' or 'wind,' and the function will return environmental stations that collect the specified elements ('fuzzy search'). Keep in mind that the database contains ~107,000 stations, worldwide. Searching for a general term such as 'temperature' will return many stations. The user is advised to search for more granular terms, e.g., using sub terms such as 'air temperature,' or 'soil temperature,' if they wish to narrow their results. See '?getVars' for more help.

startVarsDate

(character) start date in the form of "YYYY-MM-DD" for filtering environmental variables by active measurement dates. Optional

endVarsDate

(character) end date in the form of "YYYY-MM-DD" for filtering environmental variables by active measurement dates. Optional

id

(character) identifier(s) of interest. Metadata are available for stations with any of the identifiers listed below. It should be noted that a single station man have multiple, associated identifers. See '?getId' for more information.

startDate

(character) "YYYY-MM-DD" used to filter start dates of environmental stations within the metScanR database. Optional if endDate is initialized. Required if endDate is missing. See '?getDates' for more information.

endDate

(character) "YYYY-MM-DD" used to filter end dates of environmental stations within the metScanR database. Optional if startDate is initialized. Required if startDate is missing. See '?getDates' for more information.

includeUnk

(logical) Defaults to FALSE and excludes sites with unknown start dates. Setting to TRUE will include sites with unknown start dates. Sites with unknown start dates account for ~71 percent of the metScanR database. This is a result of undocumented, government (or network/governing body) metadata. Nearly all stations within the database have a known end date, however. Initializing endDate (while leaving startDate uninitialized) and setting includeUnk=TRUE will more than likely return results than if startDate is also initialized. See '?getDates' for more information.

elevMin

(numeric) defines minimum elevation (m) to filter metadata.

elevMax

(numeric) defines maximum elevation (m) to filter metadata.

territory

(character) state/territory abbreviation (e.g., 'RI'= Rhode Island, United States;'YT' = Yukon Territory, Canada)to filter environmental monitoring stations.

...

Depracated terms from previous version of function.

Value

A list comprising metadata of environmental monitoring stations from country(ies)/territory(ies) specified in country

Author(s)

Josh Roberti [email protected]
Cody Flagg
Lee Stanish
Sam Weintraub
Derek Smith

See Also

getNearby getElevation getDates getNetwork getVars getCountry getId mapSiteFinder metScanR_DB

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
#Return metadata of sites within 50 km of NEON's HARV active from 1965-10-20 to 1986-09-02
  siteFinder(siteID="NEON:HARV",startDate="1965-10-20",
  endDate="1986-09-02",radius=50)

#Return metadata of SCAN, SNTL, and ASOS sites active from at least 2000-01-05 onward
  siteFinder(network=c("SCAN","SNTL","ASOS"),startDate="2000-01-05")

#Return metadata of sites in Brazil with elevations of 1500 +/- 250 (m) Above Sea Level
  siteFinder(minElev=1000,maxElev=1800,country="Brazil")
## End(Not run)

metScanR documentation built on March 19, 2018, 9:04 a.m.