check_rec_unit_cell_validity: Validity and compatibility of a cry object of class...

Description Usage Arguments Value Examples

View source: R/validations.R

Description

An object of class 'rec_unit_cell' is a named list of length 6. The first three fields are numeric, the last three of class 'angle'.

Usage

1

Arguments

x

Object of class 'rec_unit_cell'.

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'rec_unit_cell'.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Create an object of class 'rec_unit_cell'
x <- create_rec_unit_cell()

# Check its validity
check_rec_unit_cell_validity(x)

# Now change a field
x$alphar <- 123

# Check validity again
check_rec_unit_cell_validity(x,TRUE)

cry documentation built on May 3, 2021, 9:06 a.m.