spin_sh: Spin a bash script into Rmd

In charlotte-ngs/rmdhelp: RMarkdown Helper

Spin a bash script into Rmd

Description

This function is derived from knitr::spin() for R-scripts and is adapted to do a similar conversion of bash scripts into Rmd files. The conversion is done in a simple way and almost no features of the original are provided. This is just a very crude way to have a look at documentation of a shell script in a nicer format such as html or pdf.

Usage

spin_sh(
  ps_sh_hair,
  ps_out_rmd = paste0(fs::path_ext_remove(ps_sh_hair), ".Rmd")
)

Arguments

ps_sh_hair	path to the bash scirpt
ps_out_rmd	output Rmd file

Examples

s_test_script <- system.file('extdata', 'test_script.sh', package = 'rmdhelp')
s_test_out <- file.path(tempdir(), 'test_script.Rmd')
spin_sh(ps_sh_hair = s_test_script, ps_out_rmd = s_test_out)
unlink(s_test_out)
In case the script starts with the path to bash remove it.
Insert the chunk borders
There are two types of chunks:

1. text chunks where text chunks are all lines that start with "#'"
2. code chunks are all lines that are not text chunks.

From the definitions given above it seams easier to start with text chunks
Start with the beginning of a code chunk
End of code chunks
## Replacements to get to a rmd document
The code chunks are augmented with the tiks and engine specs
The code chunk ends are symbolised with three tiks which are added at each beginning of the line
Remove all doxygen comment signs from text

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