rmd_vec_mat: Generic Converter of Matrices To Rmarkdown

In charlotte-ngs/rmdhelp: RMarkdown Helper

Generic Converter of Matrices To Rmarkdown

Description

The generic conversion takes a matrix and converts it into one of the constructs recognized by Rmarkdown as described on https://bookdown.org/yihui/rmarkdown/markdown-syntax.html.

Usage

rmd_vec_mat(
  pmat,
  ps_name = NULL,
  ps_equal_sign = "=",
  ps_env = NULL,
  ps_out_type = "array",
  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_type	one of the output types available in Rmarkdown
ps_out_format	output format produced

Details

— title: Vectors and Matrices in Rmarkdown date: 2020-05-25 —

This function is not called directly, but is used by different wrappers for the different output types.

Value

sresult String containing Rmarkdown representation of given vector or matrix

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