Skip to contents

Format isotopes in nuclear notation

Source: R/format_nucl.R
format_nucl.Rd

Convert chemical element or isotope from from hyphenated notation to nuclear notation.

Usage

format_nucl(
  x,
  face = "plain",
  ...,
  Z = formatdown_options("Z"),
  warn = formatdown_options("warn"),
  delim = formatdown_options("delim")
)

Arguments

x

Character. Hyphenated form of chemical elements or isotopes. Can be a single character string or a vector of strings. Must include a single hyphen between the element symbol and the mass number. For example, carbon 12 in hyphenated notation is the character string "C-12".

face

Font face. Determines the font face macro inside the math delimiters. Possible values are "plain" (default), "italic", "bold", "sans", or "mono". One may assign instead the corresponding LaTeX-style markup itself, e.g., \mathrm, \mathit, \mathbf, \mathsf, or \mathtt.

...

Not used for values; forces subsequent arguments to be referable only by name.

Z

T/F add the atomic number. For details, see the help page for formatdown_options().

warn

T/F issue warning for incorrect input x. For details, see the help page for formatdown_options().

delim

The math-delimiter. For details, see the help page for formatdown_options().

Value

A character vector of isotopes in nuclear notation with elements delimited as inline math markup in plain, italic, sans serif, bold, or monospace font face.

Details

We start with a character string in hyphenated form X-A where X is the chemical symbol of an element and A is its mass number. For example, carbon 12 would be written as the string "C-12".

Given a character scalar, vector, or data frame column of isotopes in this form, format_nucl() constructs the form "$\\mathxx{^{A}X}$" where \\mathxx determines the font face: plain type is set by \\mathrm; italic by \\mathit; bold by \\mathbf; sans serif by \\mathsf; and monospace (typewriter text) by \\mathtt. The result includes markup delimiters $...$ for rendering (in an R markdown or Quarto markdown document) as an inline code chunk.

Unlike other functions in formatdown, format_nucl() does not support a size argument.

See also

Other format_*: format_dcml(), format_engr(), format_numbers(), format_sci(), format_text()

Examples

# default arguments
x <- "C-12"
format_nucl(x)
#> [1] "$\\mathrm{^{12}C}$"

# add atomic number
format_nucl(x, Z = TRUE)
#> [1] "$\\mathrm{^{12}_{6}C}$"

# vector of isotopes
x <- c("C-12", "Fe-54", "U-238")
format_nucl(x, Z = TRUE)
#> [1] "$\\mathrm{^{12}_{6}C}$"   "$\\mathrm{^{54}_{26}Fe}$"
#> [3] "$\\mathrm{^{238}_{92}U}$"

# turn off the warning when using symbols
x <- "X-A"
format_nucl(x, Z = TRUE, warn = FALSE)
#> [1] "$\\mathrm{^{A}_{Z}X}$"

# change the typeface
x <- "C-12"
format_nucl(x, face = "bold")
#> [1] "$\\mathbf{^{12}C}$"

# obtain all possible mass numbers for an element
element_set[symbol == "Ca"]
#>    element symbol atomic_number mass_number
#>     <char> <char>        <char>      <char>
#> 1: Calcium     Ca            20          40
#> 2: Calcium     Ca            20          42
#> 3: Calcium     Ca            20          43
#> 4: Calcium     Ca            20          44
#> 5: Calcium     Ca            20          46
#> 6: Calcium     Ca            20          48