assertions in metrics functions. This fixes #23

R/metrics.R

@@ -668,7 +668,13 @@ daily_metrics <- function(
   metadata = NULL,
   ...
 ) {
-
+
+  # when tidy is TRUE, ensure metadata is not null before do anything to
+  # catch the error before any computation is done
+  if (isTRUE(tidy) && is.null(metadata)) {
+    stop("If tidy = TRUE, a metadata object (usually the result of read_sfn_metadata) must be provided in the metadata argument")
+  }
+
   # hack for cran tests
   . <- NULL
 
@@ -734,6 +740,12 @@ monthly_metrics <- function(
   ...
 ) {
 
+  # when tidy is TRUE, ensure metadata is not null before do anything to
+  # catch the error before any computation is done
+  if (isTRUE(tidy) && is.null(metadata)) {
+    stop("If tidy = TRUE, a metadata object (usually the result of read_sfn_metadata) must be provided in the metadata argument")
+  }
+
   . <- NULL
 
   # hardcoded values
@@ -818,6 +830,12 @@ nightly_metrics <- function(
   ...
 ) {
 
+  # when tidy is TRUE, ensure metadata is not null before do anything to
+  # catch the error before any computation is done
+  if (isTRUE(tidy) && is.null(metadata)) {
+    stop("If tidy = TRUE, a metadata object (usually the result of read_sfn_metadata) must be provided in the metadata argument")
+  }
+
   . <- NULL
 
   period <- match.arg(period)
@@ -900,6 +918,12 @@ daylight_metrics <- function(
   ...
 ) {
 
+  # when tidy is TRUE, ensure metadata is not null before do anything to
+  # catch the error before any computation is done
+  if (isTRUE(tidy) && is.null(metadata)) {
+    stop("If tidy = TRUE, a metadata object (usually the result of read_sfn_metadata) must be provided in the metadata argument")
+  }
+
   . <- NULL
 
   period <- match.arg(period)
@@ -984,6 +1008,12 @@ predawn_metrics <- function(
   ...
 ) {
 
+  # when tidy is TRUE, ensure metadata is not null before do anything to
+  # catch the error before any computation is done
+  if (isTRUE(tidy) && is.null(metadata)) {
+    stop("If tidy = TRUE, a metadata object (usually the result of read_sfn_metadata) must be provided in the metadata argument")
+  }
+
   . <- NULL
 
   period <- match.arg(period)
@@ -1064,6 +1094,12 @@ midday_metrics <- function(
   ...
 ) {
 
+  # when tidy is TRUE, ensure metadata is not null before do anything to
+  # catch the error before any computation is done
+  if (isTRUE(tidy) && is.null(metadata)) {
+    stop("If tidy = TRUE, a metadata object (usually the result of read_sfn_metadata) must be provided in the metadata argument")
+  }
+
   . <- NULL
 
   period <- match.arg(period)

tests/testthat/test-metrics.R

@@ -684,6 +684,9 @@ test_that('daily metrics examples work', {
   expect_s3_class(test_expr3[['ARG_TRE']][['sapf']], 'tbl')
   expect_s3_class(test_expr4, 'tbl')
 
+  # expected errors
+  expect_error(daily_metrics(ARG_TRE, tidy = TRUE), "metadata argument")
+
 })
 
 test_that('monthly metrics examples work', {
@@ -702,6 +705,9 @@ test_that('monthly metrics examples work', {
   expect_s3_class(test_expr3[['ARG_TRE']][['env']], 'tbl')
   expect_s3_class(test_expr3[['ARG_TRE']][['sapf']], 'tbl')
   expect_s3_class(test_expr4, 'tbl')
+
+  # expected errors
+  expect_error(monthly_metrics(ARG_TRE, tidy = TRUE), "metadata argument")
 
 })
 
@@ -721,6 +727,9 @@ test_that('nightly metrics examples work', {
   expect_s3_class(test_expr3[['ARG_TRE']][['env']], 'tbl')
   expect_s3_class(test_expr3[['ARG_TRE']][['sapf']], 'tbl')
   expect_s3_class(test_expr4, 'tbl')
+
+  # expected errors
+  expect_error(nightly_metrics(ARG_TRE, tidy = TRUE), "metadata argument")
 
 })
 
@@ -740,6 +749,9 @@ test_that('daylight metrics examples work', {
   expect_s3_class(test_expr3[['ARG_TRE']][['env']], 'tbl')
   expect_s3_class(test_expr3[['ARG_TRE']][['sapf']], 'tbl')
   expect_s3_class(test_expr4, 'tbl')
+
+  # expected errors
+  expect_error(daylight_metrics(ARG_TRE, tidy = TRUE), "metadata argument")
 
 })
 
@@ -759,6 +771,9 @@ test_that('predawn metrics examples work', {
   expect_s3_class(test_expr3[['ARG_TRE']][['env']], 'tbl')
   expect_s3_class(test_expr3[['ARG_TRE']][['sapf']], 'tbl')
   expect_s3_class(test_expr4, 'tbl')
+
+  # expected errors
+  expect_error(predawn_metrics(ARG_TRE, tidy = TRUE), "metadata argument")
 
 })
 
@@ -778,6 +793,9 @@ test_that('midday metrics examples work', {
   expect_s3_class(test_expr3[['ARG_TRE']][['env']], 'tbl')
   expect_s3_class(test_expr3[['ARG_TRE']][['sapf']], 'tbl')
   expect_s3_class(test_expr4, 'tbl')
+
+  # expected errors
+  expect_error(midday_metrics(ARG_TRE, tidy = TRUE), "metadata argument")
 
 })