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

This is an R interface to the python package 'excerpts' (< https://pypi.python.org/pypi/excerpts>).

This is an R interface to excerpts.

Introduction

Please read the vignette.

Or, after installation, 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 (<URL:
##      https://pypi.python.org/pypi/excerpts>).
## 
## Details:
## 
##      You will probably only want to use 'excerptr', see there for a
##      usage example. All other functions documented are rather meant for
##      internal use.

System Requirements

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

Installation

Unix

Install the rPython package, see file INSTALL there, or use the following code:

download.file("https://raw.githubusercontent.com/fvafrCU/cuutils/master/R/install_cran.R", 
              tmpf <- tempfile())
source(tmpf)
install_cran("rPython")

then install excerptr from CRAN

install.packages("excerptr")

Windows

Install rPython-win (following the instructions at https://cran.r-project.org/package=rPython/INSTALL ), or use the following code:

download.file("https://raw.githubusercontent.com/fvafrCU/cuutils/master/R/install_cran.R", 
              tmpf <- tempfile())
source(tmpf)
install_cran("rPython")

Then install excerptr:

download.file("https://raw.githubusercontent.com/fvafrCU/cuutils/master/R/install_cran.R", 
              tmpf <- tempfile())
source(tmpf)
install_cran("excerptr")