Skip to content

Commit

Permalink
srr docs tests/
Browse files Browse the repository at this point in the history
  • Loading branch information
pachadotdev committed Oct 25, 2024
1 parent 05b7c14 commit a460b61
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 1 deletion.
1 change: 1 addition & 0 deletions tests/testthat/test-feglm.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
#' @srrstats {RE7.2} Demonstrate that output objects retain aspects of input data such as row or case names (see **RE1.3**).
#' @srrstats {RE7.3} Demonstrate and test expected behaviour when objects returned from regression software are submitted to the accessor methods of **RE4.2**--**RE4.7**.
#' @srrstats {RE7.4} Extending directly from **RE4.15**, where appropriate, tests should demonstrate and confirm that forecast errors, confidence intervals, or equivalent values increase with forecast horizons.
#'
#' @noRd
NULL

Expand Down
1 change: 1 addition & 0 deletions tests/testthat/test-felm.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
#' @srrstats {RE7.2} Demonstrate that output objects retain aspects of input data such as row or case names (see **RE1.3**).
#' @srrstats {RE7.3} Demonstrate and test expected behaviour when objects returned from regression software are submitted to the accessor methods of **RE4.2**--**RE4.7**.
#' @srrstats {RE7.4} Extending directly from **RE4.15**, where appropriate, tests should demonstrate and confirm that forecast errors, confidence intervals, or equivalent values increase with forecast horizons.
#'
#' @noRd
NULL

Expand Down
1 change: 1 addition & 0 deletions tests/testthat/test-fenegbin.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#' @srrstatsVerbose TRUE
#'
#' @srrstats {G5.12} *Any conditions necessary to run extended tests such as platform requirements, memory, expected runtime, and artefacts produced that may need manual inspection, should be described in developer documentation such as a `CONTRIBUTING.md` or `tests/README.md` file.*
#'
#' @noRd
NULL

Expand Down
3 changes: 2 additions & 1 deletion tests/testthat/test-fepoisson.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
#' @srrstatsVerbose TRUE
#'
#' @srrstats {G5.12} *Any conditions necessary to run extended tests such as platform requirements, memory, expected runtime, and artefacts produced that may need manual inspection, should be described in developer documentation such as a `CONTRIBUTING.md` or `tests/README.md` file.*
#' @noRd
#'
#' @noRd
NULL

test_that("fepoisson is similar to fixest", {
Expand Down
11 changes: 11 additions & 0 deletions tests/testthat/test-fixed-effects.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
#' srr_stats (tests)
#'
#' @srrstatsVerbose TRUE
#'
#' @srrstats {G5.6} **Parameter recovery tests** *to test that the implementation produce expected results given data with known properties. For instance, a linear regression algorithm should return expected coefficient values for a simulated data set generated from a linear model.*
#' @srrstats {G5.6a} *Parameter recovery tests should generally be expected to succeed within a defined tolerance rather than recovering exact values.*
#' @srrstats {G5.6b} *Parameter recovery tests should be run with multiple random seeds when either data simulation or the algorithm contains a random component. (When long-running, such tests may be part of an extended, rather than regular, test suite; see G5.10-4.12, below).*
#'
#' @noRd
NULL

test_that("fixed_effects is similar to glm", {
# this is also tested in feglm with real data
# this is about SRR {G5.6b}:
Expand Down

0 comments on commit a460b61

Please sign in to comment.