check_angle_validity: Validity and compatibility of a cry object of class 'angle'

View source: R/validations.R

check_angle_validityR Documentation

Validity and compatibility of a cry object of class 'angle'

Description

An object of class 'angle' is a numeric with logical attribute "rad_flag".

Usage

check_angle_validity(x, message = FALSE)

Arguments

x

Object of class angle.

message

A logical variable. If TRUE, the function prints a message on the errors, if any (default is FALSE, i.e. no message printed).

Value

ans A logical value. TRUE means that the input is a valid object of class 'angle'.

Examples

# Create an object of class angle
x <- angle(80)

# Check its validity
check_angle_validity(x)

# Modify the 'rad_flag' attribute
attr(x,"rad_flag") <- 12.5

# Check its validity
check_angle_validity(x,TRUE)


cry documentation built on Oct. 10, 2022, 9:06 a.m.