ff_sup_clean_mlx: Convert mlx files to tex and pdf

Description Usage Arguments Value Author(s) References Examples

View source: R/ff_sup_inout.R

Description

If a mlx file has been edited, in math4econ for example, check it against git and convert to tex and pdf using command line matlab. Then the function wraps ff_sup_clean_rmd

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
ff_sup_clean_mlx(
  st_prj_root,
  ar_spt_root,
  ar_spn_skip,
  st_pattern = ".mlx",
  st_folder_pdf = "htmlpdfm/",
  st_folder_html = "htmlpdfm/",
  st_folder_m = "htmlpdfm/",
  st_folder_html_m = "",
  st_folder_rmd = "",
  bl_gen_if_git_old = FALSE,
  bl_recursive = TRUE,
  bl_verbose = TRUE,
  bl_test = TRUE,
  it_hierachy_shift = 2,
  it_toc_depth = 3,
  st_conda_env = "wk_pyfan"
)

Arguments

st_prj_root

string project root for image folder movement

ar_spt_root

array a string array of path roots in which to search for Rmd files to knit

ar_spn_skip

array a string array of names, if path found contains any of the string

st_pattern

string search pattern suffix in the array, will skip.

st_folder_pdf

string subfolder where to store the pdf file, if just empty, store in rmd folder

st_folder_html

string subfolder where to store the html file, if just empty, store in rmd folder

bl_gen_if_git_old

boolean if true then even if RMD files do not have git status change, still update pdf and html files.

bl_recursive

boolean if to search in folders recursively

bl_test

boolean if testing, meaning do not generate pdf html, just see which files are been

it_hierachy_shift

rmd modification level of promotion from bookdown hierachy to own file hierarchy

it_toc_depth

rmd own file outputs toc levels to show considered included, searched and found

st_conda_env

string variable of conda env name

st_folder_R

string subfolder where to store the R file, if just empty, store in rmd folder

Value

a list of string paths of files generated

#'

Author(s)

Fan Wang, http://fanwangecon.github.io

References

https://fanwangecon.github.io/R4Econ/development/inout/fs_rmd_pdf_html.html https://github.com/FanWangEcon/REconTools/blob/master/R/ff_sup_inout.R

Examples

1
2
3
ar_spt_root = c('C:/Users/fan/Math4Econ/math/matrix_application')
ar_spn_skip <- c('matrix', 'tibble', '_main', '_mod')
ff_sup_clean_mlx(ar_spt_root, ar_spn_skip)

FanWangEcon/REconTools documentation built on Jan. 21, 2022, 10:28 p.m.