Update srr

Author: paulgovan

data-raw/TESTDATA.R

@@ -1,4 +1,7 @@
-## code to prepare `testdata` dataset
+
+#' @srrstats {G5.0} The data set is a standard data set from a published paper.
+#' @srrstats {G5.1} The data set is created within and used to test the package.
+#' The data set is exported so that users can confirm tests and run examples.
 
 testdata <- data.frame(
   LRU = c(rep("G1", 15), rep("G2", 10)),

tests/testthat/test-srr-duane.R

@@ -1,3 +1,26 @@
+
+#' @srrstats {G5.1} The function is tested with a standard data set. The data set is
+#' created within and used to test the package. The data set is exported so that users
+#' can confirm tests and run examples.
+#' @srrstats {G5.2} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.2a} Every message produced by `stop()` is unique.
+#' @srrstats {G5.2b} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.4} Unit tests include correctness tests to test that statistical algorithms produce expected results to some fixed test data sets.
+#' @srrstats {G5.4c} Unit tests include stored values that are drawn from a published paper output.
+#' @srrstats {G5.5} Correctness tests are run with a fixed random seed.
+#' @srrstats {G5.6} Unit tests include parameter recovery checks to test that the implementation produce expected results given data with known properties.
+#' @srrstats {G5.6a} Parameter recovery tests are expected to be within a defined tolerance rather than exact values.
+#' @srrstats {G5.7} Unit tests include algorithm performance checks to test that the function performs as expected as data changes.
+#' @srrstats {G5.8} See sub-tags for responses.
+#' @srrstats {G5.8a} Unit tests include checks for zero-length data.
+#' @srrstats {G5.8b} Unit tests include checks for unsupported data types.
+#' @srrstats {G5.8c} Unit tests include checks for data with 'NA' fields.
+#' @srrstats {G5.8d} Unit tests include checks for data outside the scope of the algorithm.
+#' @srrstats {G5.9} Unit tests include noise susceptibility tests for expected stochastic behavior.
+#' @srrstats {G5.9a} Unit tests check that adding trivial noise to data does not meaningfully change results.
+#' @srrstats {G5.9b} Unit tests check that different random seeds do not meaningfully change results.
+#' @srrstats {G5.10} All unit tests run as part of continuous integration.
+
 set.seed(123)
 
 test_that("data.frame input works the same as separate vectors", {

tests/testthat/test-srr-gof.R

@@ -1,3 +1,14 @@
+
+#' @srrstats {G5.2} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.2a} Every message produced by `stop()` is unique.
+#' @srrstats {G5.2b} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.8} See sub-tags for responses.
+#' @srrstats {G5.8a} Unit tests include checks for zero-length data.
+#' @srrstats {G5.8b} Unit tests include checks for unsupported data types.
+#' @srrstats {G5.8c} Unit tests include checks for data with 'NA' fields.
+#' @srrstats {G5.8d} Unit tests include checks for data outside the scope of the algorithm.
+#' @srrstats {G5.10} All unit tests run as part of continuous integration.
+
 test_that("qqplot.rga() errors on invalid inputs", {
   # Not an rga object
   expect_error(

tests/testthat/test-srr-rga.R

@@ -1,3 +1,27 @@
+
+#' @srrstats {G5.0} The function is tested with a standard data set from a published paper.
+#' @srrstats {G5.1} The function is tested with a standard data set. The data set is
+#' created within and used to test the package. The data set is exported so that users
+#' can confirm tests and run examples.
+#' @srrstats {G5.2} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.2a} Every message produced by `stop()` is unique.
+#' @srrstats {G5.2b} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.4} Unit tests include correctness tests to test that statistical algorithms produce expected results to some fixed test data sets.
+#' @srrstats {G5.4c} Unit tests include stored values that are drawn from a published paper output.
+#' @srrstats {G5.5} Correctness tests are run with a fixed random seed.
+#' @srrstats {G5.6} Unit tests include parameter recovery checks to test that the implementation produces expected results given data with known properties.
+#' @srrstats {G5.6a} Parameter recovery tests are expected to be within a defined tolerance rather than exact values.
+#' @srrstats {G5.7} Unit tests include algorithm performance checks to test that the function performs as expected as parameters change.
+#' @srrstats {G5.8} See sub-tags for responses.
+#' @srrstats {G5.8a} Unit tests include checks for zero-length data.
+#' @srrstats {G5.8b} Unit tests include checks for unsupported data types.
+#' @srrstats {G5.8c} Unit tests include checks for data with 'NA' fields.
+#' @srrstats {G5.8d} Unit tests include checks for data outside the scope of the algorithm.
+#' @srrstats {G5.9} Unit tests include noise susceptibility tests for expected stochastic behavior.
+#' @srrstats {G5.9a} Unit tests check that adding trivial noise to data does not meaningfully change results.
+#' @srrstats {G5.9b} Unit tests check that different random seeds do not meaningfully change results.
+#' @srrstats {G5.10} All unit tests run as part of continuous integration.
+
 test_that("data.frame input works the same as separate vectors", {
   times <- c(100, 200, 300)
   failures <- c(1, 2, 1)

tests/testthat/test-srr-testdata.R

@@ -1,3 +1,8 @@
+
+#' @srrstats {G5.1} The data set is created within and used to test the package.
+#' The data set is exported so that users can confirm tests and run examples.
+#' @srrstats {G5.10} All unit tests run as part of continuous integration.
+
 test_that("testdata dataset has expected structure", {
   data("testdata", package = "ReliaGrowR")
 

tests/testthat/test-srr-weibull_to_rga.R

@@ -1,3 +1,17 @@
+
+#' @srrstats {G5.2} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.2a} Every message produced by `stop()` is unique.
+#' @srrstats {G5.2b} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.4} Unit tests include correctness tests to test that statistical
+#' algorithms produce expected results to some fixed test data sets.
+#' @srrstats {G5.5} Correctness tests are run with a fixed random seed.
+#' @srrstats {G5.8} See sub-tags for responses.
+#' @srrstats {G5.8a} Unit tests include checks for zero-length data.
+#' @srrstats {G5.8b} Unit tests include checks for unsupported data types.
+#' @srrstats {G5.8c} Unit tests include checks for data with 'NA' fields.
+#' @srrstats {G5.8d} Unit tests include checks for data outside the scope of the algorithm.
+#' @srrstats {G5.10} All unit tests run as part of continuous integration.
+
 test_that("weibull_to_rga() input validation errors", {
   # failures
   expect_error(

tests/testthat/test-srr_rdt.R

@@ -1,3 +1,19 @@
+
+#' @srrstats {G5.2} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.2a} Every message produced by `stop()` is unique.
+#' @srrstats {G5.2b} Unit tests demonstrate error messages and compare results with expected values.
+#' @srrstats {G5.4} Unit tests include correctness tests to test that statistical
+#' algorithms produce expected results to some fixed test data sets.
+#' @srrstats {G5.5} Correctness tests are run with a fixed random seed.
+#' @srrstats {G5.8} See sub-tags for responses.
+#' @srrstats {G5.8a} Unit tests include checks for zero-length data.
+#' @srrstats {G5.8b} Unit tests include checks for unsupported data types.
+#' @srrstats {G5.8c} Unit tests include checks for data with 'NA' fields.
+#' @srrstats {G5.8d} Unit tests include checks for data outside the scope of the algorithm.
+#' @srrstats {G5.9} Unit tests include noise susceptibility tests for expected stochastic behavior.
+#' @srrstats {G5.9a} Unit tests check that adding trivial noise to data does not meaningfully change results.
+#' @srrstats {G5.10} All unit tests run as part of continuous integration.
+
 test_that("rdt() input validation errors", {
   # target
   expect_error(