Skip to content

Commit

Permalink
complete srr descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
pachadotdev committed Nov 23, 2024
1 parent dc0e78f commit bcfc745
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion R/apes.R
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ apes <- function(

#' srr_stats
#' @srrstats {G2.0} Implements assertions to ensure valid scaling relationships between population size and sample size.
#' @srrstatsTODO {G2.0a} The main function explains that the inputs are unidimensional or the function gives an error.
#' @srrstats {G2.0a} The main function explains that the inputs are unidimensional or the function gives an error.
#' @srrstats {G5.2a} Issues clear warnings for invalid population adjustments or mismatched sizes.
#' @noRd
NULL
Expand Down
8 changes: 7 additions & 1 deletion R/capybara-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@
#' in this implementation compare to base R.
#' @srrstats {G1.6} To keep dependencies minimal, we compare against base R in
#' the tests. An alternative would be to compare against alpaca.
#' @srrstatsNA {G5.6a} No randomness in parameter estimation; deterministic methods used.
#' @noRd
NULL

#' NA_standards
#' @srrstatsNA {G5.6b} No randomness is needed for the in fixed effects
#' estimation. With the model slopes, recovering the fixed effects is a
#' deterministic process.
#' @srrstatsNA {RE7.0a} No cross-validation implemented in this package.
#' @noRd
NULL
Expand Down
2 changes: 1 addition & 1 deletion R/feglm_control.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' srr_stats
#' @srrstats {G1.0} Implements controls for efficient and numerically stable fitting of generalized linear models with fixed effects.
#' @srrstats {G2.0} Validates numeric input parameters to ensure they meet constraints (e.g., positive tolerance levels).
#' @srrstatsTODO {G2.0a} The main function explains that the tolerance must be unidimensional or the function gives an error.
#' @srrstats {G2.0a} The main function explains that the tolerance must be unidimensional or the function gives an error.
#' @srrstats {G2.1a} Ensures the proper data types for arguments (e.g., logical for `trace`, integer for `iter_max`).
#' @srrstats {G2.3a} Uses argument validation to ensure appropriate ranges for critical parameters (e.g., `iter_max` and `limit` >= 1).
#' @srrstats {G2.14a} Provides informative error messages when tolerance levels or iteration counts are invalid.
Expand Down

0 comments on commit bcfc745

Please sign in to comment.