readTimeSeries: Read time series

Description Usage Arguments

View source: R/utils-read.R

Description

Reads and formats a time series from the provided full report object

Usage

1
2
3
readTimeSeries(reportObject, seriesName, timezone,
  descriptionField = NULL, shiftTimeToNoon = FALSE, isDV = FALSE,
  estimated = FALSE, requiredFields = NULL, onlyMonth = NULL)

Arguments

reportObject

the full JSON report object

seriesName

the name of the time series to extract

timezone

the timezone to parse times to

descriptionField

The JSON field name to fetch description inofmration from

shiftTimeToNoon

[DEFAULT: FALSE] whether or not to shift DV times to noon

isDV

whether or not the specified time series is a daily value time series

estimated

whether or not the time series should be marked as estimated

requiredFields

optional overriding of required fields for a time series

onlyMonth

4 character month code to limit points to (EG: "1608" only includes August 2016 points)


USGS-R/repgen documentation built on April 14, 2021, 2:47 p.m.