getHilltopEnsembleStats: General function to get ensemblestats data from a Hilltop...

In jeffcnz/hillr: Interaction With A Hilltop Timeseries Server

General function to get ensemblestats data from a Hilltop server.

Description

getHilltopEnsembleStats retrieves time series data from a Hilltop server.

Usage

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

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.
byYear	boolean A flag to indicate whether you want ensemble stats for each year. Note: If true then the returned data will be for full years based on the from year and to year where data is available

Details

Takes a valid Hilltop server endpoint, a site name, a measurement name and optional from, to or timeIntervaland arguments, a Statistic and optional upper and lower percentile arguments and byYear argument. Returns a dataframe of the relevant Ensemble Statistics for that site and measurement for the requested time range from the endpoint.

Value

dataframe A dataframe of the ensemble stats.

jeffcnz/hillr documentation built on Nov. 21, 2024, 11:58 p.m.