R/check_epochs.R

In richelbilderbeek/gcaer: Interface to GCAE

#' Check if the `epochs` is valid
#'
#' Check if the `epochs` is valid
#' Will \link{stop} if not.
#'
#' Note that in some contexts, `epochs` cannot be zero.
#' That condition will be checked in that context.
#' @inheritParams default_params_doc
#' @return Nothing. Will \link{stop} if `epochs` is invalid.
#' @examples
#' check_epochs(0)
#' check_epochs(1)
#' check_epochs(100)
#' @author Richèl J.C. Bilderbeek
#' @export
check_epochs <- function(
  epochs
) {
  testthat::expect_equal(1, length(epochs))
  testthat::expect_true(is.numeric(epochs))
  testthat::expect_true(is.finite(epochs))
  testthat::expect_equal(epochs, round(epochs))
  testthat::expect_true(epochs >= 0)
  invisible(epochs)
}