chem_markdown: Format objects as markdown

Description Usage Arguments Value Examples

View source: R/formatting.R

Description

Format objects as markdown

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
chem_markdown(x, ...)

## Default S3 method:
chem_markdown(x, ...)

## S3 method for class 'reaction'
chem_markdown(x, equals_sign = NULL, ...)

## S3 method for class 'reaction_list'
chem_markdown(x, ...)

Arguments

x

A mol, reaction, or reaction list object

...

Passed to as.character()

equals_sign

An equals sign to use for a reaction object

Value

A character vector formatted for markdown

Examples

1
2
3
chem_markdown(as_reaction("2H+ + 2OH- = 2H2O"))
chem_markdown(as_reaction_list("2H+ + 2OH- = 2H2O"))
chem_markdown(as_mol(c("SO4-2", "Ca+2")))

paleolimbot/chemr documentation built on Sept. 11, 2021, 2:02 p.m.