fullGetHilltopEnsembleStats: Multiple sites and measurements Ensemble STatistics to...

In jeffcnz/hillr: Interaction With A Hilltop Timeseries Server

Multiple sites and measurements Ensemble STatistics to Dataframe.

Description

fullGetHilltopEnsembleStats returns a dataframe of requested Ensemble Stats for measurements at sites.

Usage

fullGetHilltopEnsembleStats(
  endpoint,
  sites,
  measurements,
  from = NULL,
  to = NULL,
  timeInterval = NULL,
  statistic = "MonthlyPDF",
  lowerPercentile = NULL,
  upperPercentile = NULL,
  byYear = FALSE
)

Arguments

endpoint	string A valid hilltop endpoint.
sites	string vector The sites that data is to be requested from.
measurements	string vector The measurements that are to be requested.
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 vector of site names, a vector of measurement names 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 the requested sites and measurements for the requested time range from the endpoint.

Value

dataframe of measurements with optional metadata for requested sites.

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