buildEnsembleStatsRequestUrl: Create a url to request ensemble statistics for a site and...
In jeffcnz/hillr: Interaction With A Hilltop Timeseries Server

buildEnsembleStatsRequestUrl

R Documentation

Create a url to request ensemble statistics for a site and measurement.

Description

buildEnsembleStatsRequestUrl returns a url to request ensemble statisticss for a site and measurement

Usage

buildEnsembleStatsRequestUrl(
  endpoint,
  site,
  measurement,
  from = NULL,
  to = NULL,
  timeInterval = NULL,
  statistic = "MonthlyPDF",
  lowerPercentile = NULL,
  upperPercentile = NULL
)

Arguments

`endpoint`	string A valid hilltop endpoint.
`site`	string A site that has data available on the server.
`measurement`	string A measurement that has data available for the requested site on the server.
`from`	string (optional) The date (or date time combination) that data is required from (if not provided only the last measurement will be provided.)
`to`	string (optional) The date (or date time combination) that data is required up to (if not provided data will be provided from the from date to the most recent data available.)
`timeInterval`	string (optional) A time interval that data is requested over, either of the form P1D, or P3M, or fromDateTime/toDateTime.
`statistic`	string The statistic function to use. Options are HourlyExtrema, DailyExtrema, MonthlyExtrema, MeanHourlyExtrema, MeanDailyExtrema, MeanMonthlyExtrema, ExtremeHourlyMean, ExtremeDailyMean, ExtremeMonthlyMean, HourlyPDF, DailyPDF, MonthlyPDF
`lowerPercentile`	string (optional) The lower percentile value to return from a PDF request.
`upperPercentile`	string (optional) The upper percentile value to return from a PDF request.

Details

Takes a valid Hilltop server endpoint, a site name, a measurement name and optional from, to or timeIntervaland arguments, and a Statistic argument and returns a url that requests the ensemble statistics for that site and measurement for the requested time range from the endpoint.