Skip to content

Commit

Permalink
update examples
Browse files Browse the repository at this point in the history
  • Loading branch information
brownag committed Sep 20, 2024
1 parent cbfa883 commit dcfe229
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 12 deletions.
20 changes: 14 additions & 6 deletions R/fetchSCAN.R
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,23 @@
#'
#' # get sensor metadata
#' m <- SCAN_sensor_metadata(site.code = c(356, 2072))
#'
#' m
#'
#' # get site metadata
#' m <- SCAN_site_metadata(site.code = c(356, 2072))
#'
#' # get hourly data (warning, result is very large ~ 11MB)
#' # x <- try(fetchSCAN(site.code = c(356, 2072), year = c(2015), timeseries = "Hourly"))
#' m
#'
#' # # get hourly data (warning, result is large ~11MB)
#' # x <- try(fetchSCAN(site.code = c(356, 2072), year = 2015, timeseries = "Hourly"))
#' #
#' # # note hourly data are in US/Central time, with standard or daylight savings time depending on day of year
#' # unique(format(x$SMS$datetime, '%Z'))
#' #
#' # note hourly data are all referenced to GMT-8, the time zone of station 356
#' # format(x$SMS$datetime[1], '%Z')
#' # # the site metadata indicate timeseries data time zone (dataTimeZone; for site 356 offset of 8 hours behind UTC)
# # # to obtain all datetime data with a consistent offset use e.g. "Etc/GMT+8"
# # # note that the sign is inverted for the Etc/GMT+n timezone specification
#' # x <- try(fetchSCAN(site.code = c(356, 2072), year = 2015, timeseries = "Hourly", tz = "Etc/GMT+8"))
#'
#' }
#' @rdname fetchSCAN
#' @export
Expand Down
18 changes: 12 additions & 6 deletions man/fetchSCAN.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit dcfe229

Please sign in to comment.