Skip to contents

Check if a number is prime

Source: R/check_prime.R
check-prime.Rd

check_prime() and check_is_prime() functions check whether the input is a prime number. The check_prime() function raises an error if the input is not a prime number, while check_is_prime() returns TRUE if the input is a prime number, and FALSE otherwise.

Usage

check_prime(num, par_name = "num")

check_is_prime(num, par_name = "num")

Arguments

num

A numeric scalar to check.

par_name

The name of the parameter to display in error messages.

Value

  • check_prime(): Returns the original value of num if it is a prime number. Raises an error message if num is not a prime number.

  • check_is_prime(): Logical value, TRUE if the input is a prime number, and FALSE otherwise.

Examples

# Examples for check_prime()
# --------------------------

check_prime(7)
#> [1] 7

try(check_prime(8))
#> Error in check_prime(8) : Expected 'num' to be a prime number but got 8

# Examples for check_is_prime()
# -----------------------------

check_is_prime(7)
#> [1] 1

check_is_prime(8)
#> [1] 0