Skip to contents

Check if a numeric vector is in scientific notation

Source: R/scientific_notation.R
check_scientific_notation.Rd

[Experimental]

*_scientific_notation() check if an argument is formatted in scientific notation.

Usage

check_scientific_notation(
  x,
  any_missing = TRUE,
  null_ok = FALSE,
  .names = deparse(substitute(x))
)

test_scientific_notation(
  x,
  any_missing = TRUE,
  null_ok = FALSE,
  .names = deparse(substitute(x))
)

assert_scientific_notation(
  x,
  any_missing = TRUE,
  null_ok = FALSE,
  .names = deparse(substitute(x)),
  .var.name = checkmate::vname(x),
  add = NULL
)

expect_scientific_notation(
  x,
  any_missing = TRUE,
  null_ok = FALSE,
  .names = deparse(substitute(x)),
  info = NULL,
  label = checkmate::vname(x)
)

Arguments

x

(Optional) A numeric vector.

any_missing

(Optional) A logical flag indicating if missing values are allowed (Default: TRUE).

null_ok

(Optional) A logical flag indicating if NULL values are allowed (Default: FALSE).

.names

(Optional) A character vector specifying the names of the objects being tested. This argument is used internally and should not be set by the user.

.var.name

(Optional) A character string indicating the name of the checked object to print in assertions. This argument is used internally and should not be set by the user.

add

(Optional) A AssertCollection object indicating the collection to store assertion messages. This argument is used internally and should not be set by the user.

info

(Optional) A character string with extra information to be included in the message for the `testthat“ reporter. This argument is used internally and should not be set by the user.

label

(Optional) A character string indicating the name of the checked object to print in messages. This argument is used internally and should not be set by the user.

Value

  • test_*: TRUE if it passes the test; FALSE otherwise.

  • check_*: TRUE if it passes the test; a string with a message otherwise.

  • assertion_*: The same input (as invisible) if it passes the test; an error message otherwise.

  • expect_*: The same input (as invisible) if it passes the test; an error message otherwise.

Examples

opt <- getOption("scipen")

options(scipen = 0)
test_scientific_notation(0.00000000000000000000000001)
#> [1] TRUE
#> [1] TRUE # Expected

options(scipen = 999)
test_scientific_notation(0.00000000000000000000000001)
#> [1] FALSE
#> [1] FALSE # Expected

options(scipen = opt)