bmatrix: Convert Matrix To bmatrix in Rmarkdown

In charlotte-ngs/rmdhelp: RMarkdown Helper

Convert Matrix To bmatrix in Rmarkdown

Description

The specified matrix is converted to a bmatrix in Rmarkdown

Usage

bmatrix(
  pmat,
  ps_name = NULL,
  ps_equal_sign = "=",
  ps_env = NULL,
  ps_out_format = "html"
)

Arguments

pmat	matrix to be converted to Rmarkdown
ps_name	variable name for the matrix
ps_equal_sign	equal sign to be used when a variable name is given
ps_env	math environment in which matrix should be presented
ps_out_format	output format produced

Details

# —- bmatrix Wrapper —————————————————- #

Value

String containing bmatrix representation of given matrix

Examples

## Not run: 
eye3 <- diag(1, nrow = 3)
bmatrix(pmat = eye3, ps_name = 'I', ps_env = '$$')

## End(Not run)

charlotte-ngs/rmdhelp documentation built on Oct. 31, 2023, 10:21 a.m.