pyfan.util.rmd.rmdparse¶
Fan Rmd Fronter Matter Core Parser
In mine Rmd files front matter, there are some special parameters that provide summaries for the key contents in the code, and also provide key programs and dependencies that were used. The information can be parsed to string lists. The special strings are meant to be used with a special README.md github pages file. The goal is to automatically gather meta-data across RMD files within folders in a package to prepare data needed to provide a detailed table of content type contents needed for a README.md file.
Module Contents¶
Functions¶
|
Parse Yaml Frontmatter to get list of paths, summaries, dependencies |
-
pyfan.util.rmd.rmdparse.fs_rmd_yml_parse(sfc_prj='R4Econ', sph_prj='C:/Users/fan/R4Econ', spn_prj_rmd='/summarize/aggregate/fs_group_unique_agg.Rmd', sph_gitpages_root='https://fanwangecon.github.io/', sph_github_root='https://github.com/FanWangEcon/', sph_branch='/master', sph_pdf='htmlpdfr', sph_html='htmlpdfr', sph_r='htmlpdfr', st_file_type='r')[source]¶ Parse Yaml Frontmatter to get list of paths, summaries, dependencies
- Parameters
- sfc_prjstring
The git project name
- sph_prjstring
the local path to the git project
- spn_prj_rmdstring
the path (within project) to the Rmd file
- sph_gitpages_rootstring
github pages site url root
- sph_github_rootstring
github project page url
- sph_branchstring
which branch
- sph_pdfstring
subfolder to store pdf files in the rmd folder
- sph_htmlstring
subfolder to store html files in the rmd folder
- sph_rstring
subfolder to store r files in the rmd folder does not have to be r, any other raw file type, m of py for example
- st_file_type: string
the RMD file is for which underlying language: r for R, m for matlab, py for python