Excerpt Structuring Comments from Your Code File and Set a Table of Contents

Ever read or wrote source files containing sectioning comments? If these comments are markdown style section comments, you can excerpt them and set a table of contents using the 'python' package 'excerpts' (< https://pypi.org/project/excerpts/>).

excerptr

Introduction

After installation, please read the help page:

help("excerptr-package", package = "excerptr")

#> Excerpt Structuring Comments from Your Code File and Set a Table of
#> Contents
#> 
#> Description:
#> 
#>      This is just an R interface to the python package excerpts
#>      (<https://pypi.org/project/excerpts/>).
#> 
#> Author(s):
#> 
#>      *Maintainer*: Andreas Dominik Cullmann
#>      <mailto:[email protected]>
#> 
#> See Also:
#> 
#>      Useful links:
#> 
#>         • <https://gitlab.com/fvafrcu/excerptr>

System Requirements

excerptr needs python3, you probably want to have pandoc and a TeX-System such as TeXLive installed.

Installation

You can install excerptr from gitlab with:

if (! require("remotes")) install.packages("remotes")
remotes::install_gitlab("fvafrcu/excerptr")