getDates: Filter environmental monitoring stations by active date(s)

Description Usage Arguments Value Author(s) References See Also Examples

View source: R/getDates.R

Description

Return metadata of environmental monitoring stations that were/are active during specified dates.

Usage

1
getDates(startDate, endDate, includeUnk = FALSE, ...)

Arguments

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.

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.

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.

...

auto-populates when called from siteFinder() wrapper

Value

A list comprising metadata of environmental monitoring sites that were/are active between the startDate and/or endDate

Author(s)

Josh Roberti [email protected]
Lee Stanish

References

see reference links above

See Also

siteFinder mapSiteFinder metScanR_DB

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
#return metadata of sites that were active from at least 1940-01-01 through 1970-04-18
  getDates(startDate="1940-01-01",endDate = "1970-04-18")
#return metadata of sites that were active up through at least 1950-07-08
  getDates(endDate = "1950-07-08")
#return metadata of sites that were active up through at least 1950-07-08
#and have an unknown start date:
  getDates(endDate = "1950-07-08", includeUnk=TRUE)
## End(Not run)

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