Improve test naming and comments

Author: capnrefsmmat

R-packages/covidcast/tests/testthat/test-cor.R

@@ -1,9 +1,10 @@
 library(covidcast)
 library(tibble)
 
-test_that("simple correlations", {
+test_that("correlations when correlation is 1", {
   # Two data frames with perfect correlation, except on a day that does not
-  # match between the two of them
+  # match between the two of them. The non-matching day does not have perfect
+  # correlation, so this will detect if it is correctly excluded.
   foo <- data.frame(
     time_value = as.Date(c("2020-01-01", "2020-01-02",
                            "2020-01-03", "2020-01-05")),
@@ -30,7 +31,7 @@ test_that("simple correlations", {
                expected)
 })
 
-test_that("basic lagged correlations", {
+test_that("lags are applied before correlating", {
   foo <- data.frame(
     time_value = as.Date(c("2020-01-01", "2020-01-02",
                            "2020-01-03", "2020-01-04")),
@@ -57,7 +58,7 @@ test_that("basic lagged correlations", {
                expected)
 })
 
-test_that("lags are in correct direction", {
+test_that("lags are applied in correct temporal direction", {
   foo <- data.frame(
     time_value = seq.Date(as.Date("2020-01-01"), as.Date("2020-01-10"),
                           "day"),
@@ -74,6 +75,7 @@ test_that("lags are in correct direction", {
     value = c(rep(0, 5), 1:5)
   )
 
+  # These data frames have correlation 1 only if lagged exactly the right amount
   expected <- tibble(
     geo_value = "pa",
     value = 1

R-packages/covidcast/tests/testthat/test-covidcast.R

@@ -1,14 +1,15 @@
 library(covidcast)
 library(mockery)
 
-test_that("covidcast_meta", {
+test_that("covidcast_meta formats result correctly", {
   stub(covidcast_meta, ".request",
        list(message = "success",
             epidata = data.frame(
               min_time = c("20200101", "20201002"),
               max_time = c("20200102", "20201003"),
               max_issue = c("20200404", "20201101"))))
 
+  # ensure columns that should be converted to dates are indeed dates
   expect_equal(covidcast_meta(),
                structure(
                  data.frame(
@@ -19,6 +20,9 @@ test_that("covidcast_meta", {
                  class = c("covidcast_meta", "data.frame")
                ))
 
+})
+
+test_that("covidcast_meta raises error when API signals one", {
   stub(covidcast_meta, ".request",
        list(message = "argle-bargle"))
 

R-packages/covidcast/tests/testthat/test-plot.R

@@ -2,6 +2,13 @@ library(testthat)
 library(vdiffr)
 library(dplyr)
 
+## Plotting tests.
+# Since it is difficult to test specific output of plots, these tests instead
+# use vdiffr to ensure that plots match a saved reference version. The tests
+# below simple build simple graphs of each type, thus exercising the different
+# plotting options and ensuring they all function.
+
+
 # Contexts are no longer required or recommended in testthat, but vdiffr still
 # wants one to place the figure files correctly. See
 # https://github.com/r-lib/vdiffr/issues/71