From 4999d25a52a7db6ab599b042319217be378917f6 Mon Sep 17 00:00:00 2001 From: nikosbosse Date: Tue, 28 Nov 2023 23:06:43 +0100 Subject: [PATCH] Rename `interval_coverage_deviation_quantile` to `interval_coverage_dev_quantile()` --- NAMESPACE | 2 +- R/metrics-quantile.R | 2 +- ...iation_quantile.Rd => interval_coverage_dev_quantile.Rd} | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) rename man/{interval_coverage_deviation_quantile.Rd => interval_coverage_dev_quantile.Rd} (94%) diff --git a/NAMESPACE b/NAMESPACE index 97d7f8b63..877111965 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -33,7 +33,7 @@ export(dss_sample) export(get_duplicate_forecasts) export(get_forecast_type) export(get_forecast_unit) -export(interval_coverage_deviation_quantile) +export(interval_coverage_dev_quantile) export(interval_coverage_quantile) export(interval_coverage_sample) export(interval_score) diff --git a/R/metrics-quantile.R b/R/metrics-quantile.R index 71b98757f..1be788c45 100644 --- a/R/metrics-quantile.R +++ b/R/metrics-quantile.R @@ -297,7 +297,7 @@ interval_coverage_quantile <- function(observed, predicted, quantile, range = 50 #' ) #' quantile <- c(0.1, 0.25, 0.5, 0.75, 0.9) #' interval_coverage_deviation_quantile(observed, predicted, quantile) -interval_coverage_deviation_quantile <- function(observed, predicted, quantile) { +interval_coverage_dev_quantile <- function(observed, predicted, quantile) { assert_input_quantile(observed, predicted, quantile) # transform available quantiles into central interval ranges diff --git a/man/interval_coverage_deviation_quantile.Rd b/man/interval_coverage_dev_quantile.Rd similarity index 94% rename from man/interval_coverage_deviation_quantile.Rd rename to man/interval_coverage_dev_quantile.Rd index 136afd8a2..9a43cdd57 100644 --- a/man/interval_coverage_deviation_quantile.Rd +++ b/man/interval_coverage_dev_quantile.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/metrics-quantile.R -\name{interval_coverage_deviation_quantile} -\alias{interval_coverage_deviation_quantile} +\name{interval_coverage_dev_quantile} +\alias{interval_coverage_dev_quantile} \title{Interval Coverage Deviation (For Quantile-Based Forecasts)} \usage{ -interval_coverage_deviation_quantile(observed, predicted, quantile) +interval_coverage_dev_quantile(observed, predicted, quantile) } \arguments{ \item{observed}{numeric vector of size n with the observed values}