translate_SG: Translation of space group symbols, numbers, etc.

Description Usage Arguments Details Value Examples

View source: R/symmetry.R

Description

Function to find out space group symbol given number and vice-versa.

Usage

1
translate_SG(value, SG_in = "number", SG_out = "xHM", set = 1)

Arguments

value

A string or an integer number corresponding to the space group being investigated.

SG_in

A string representing the space group format for the input. Possible values are:

  • 1) "number"

  • 2) "ccp4"

  • 3) "Hall"

  • 4) "xHM"

  • 5) "old"

SG_out

A string representing the space group format for the output. Possible values are:

  • 1) "number"

  • 2) "ccp4"

  • 3) "Hall"

  • 4) "xHM"

  • 5) "old"

set

Specific setting for the given space group. A number like 1,2,... It is used if for a same symbol there are more than one choice.

Details

This function returns either a number of a specific symbol corresponding to a crystallographic space group. The input is an integer number or a character symbol identifying a specific space group. The output is, similarly, the corresponding character symbol or number, according to what is specified in the input. Possible formats are:

If more than one setting is implied in an ambiguous way in the input value, then the first setting will be selected by default for the output value, unless argument "set" is set to another value.

Value

list_SG A named list with two fields. The first field, "msg", is a character string representing the space group format needed as output. Possible values are the same as those for SG_in. The second field, "ans", is TRUE only if a valid symbol for "msg" is found.

Examples

1
2
# Space Group P1 corresponds to number 1
translate_SG(value=1,SG_in="number",SG_out="xHM")

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