check_unit_cell_validity {cry} | R Documentation |
Validity and compatibility of a cry object of class 'unit_cell'
Description
An object of class 'unit_cell' is a named list of length 6. The first three fields are numeric, the last three of class 'angle'.
Usage
check_unit_cell_validity(x, message = FALSE)
Arguments
x |
Object of class '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'unit_cell'.
Examples
# Create an object of class 'unit_cell'
x <- create_unit_cell()
# Check its validity
check_unit_cell_validity(x)
# Now change a field
x$alpha <- 123
# Check validity again
check_unit_cell_validity(x,TRUE)
[Package cry version 0.5.1 Index]