check_bravais_validity: Validity and compatibility of a cry object of class 'bravais'

In cry: Statistics for Structural Crystallography

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

Description

An object of class 'bravais' is a named list of length 4. The first slot, "bt", is the universally-used two-letter symbol. The second, third and fourth slots are, respectively, "cr_fam" (the corresponding crystal family), "cr_sys" (the corresponding crystal system) and "lt_sys" (the corresponding lattice system).

Usage

check_bravais_validity(x, message = FALSE)

Arguments

x	Object of class 'bravais'.
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 'bravais'.

Examples

# Create an object of class 'bravais'
x <- bravais("mP")

# Check its validity
check_bravais_validity(x,TRUE)

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