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>).


Build Status Coverage Status CRAN_Status_Badge RStudio_downloads_monthly RStudio_downloads_total 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")

News

excerptr 1.4.1

  • Declared imports from devtools in tests as requested by CRAN on Thu, 17 May 2018 10:28:07 +0200.

excerptr 1.4.0

  • Handle exception from pandoc call via rPython using an R system call to pandoc. Calling pandoc from rPython fails on windows, so we work around using system2().

excerptr 1.3.1

  • Run tests requiring pandoc only if pandoc is installed.

excerptr 1.3.0

  • Add 'excerpts' version 2.0.0 from github and adjust the internal interface in excerptr().
  • Enhance documentation

excerptr 1.2.0

  • Add 'excerpts' version 1.1.0 from github.
  • vignettes/excerptr_Introduction.Rmd: cope with CRAN's check warnings.

excerptr 1.1.0

  • vignettes/excerptr_Introduction.Rmd: cope with CRAN's check warnings.
  • R/internals.R: construct path using inst/ only on developement.

excerptr 1.0.2

  • Change example to not require pandoc.

excerptr 1.0.1

  • Remove test failing on CRAN.

excerptr 1.0.0

  • First release, just importing excerpts.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("excerptr")

1.4.1 by Andreas Dominik Cullmann, a year ago


https://github.com/fvafrCU/excerptr


Browse source code at https://github.com/cran/excerptr


Authors: Andreas Dominik Cullmann [aut, cre]


Documentation:   PDF Manual  


BSD_2_clause + file LICENSE license


Imports utils, rPython, rprojroot, git2r

Suggests testthat, knitr, rmarkdown, devtools

System requirements: python3, rPython (see file README). To make full use of the vignette's examples you need 'pandoc' (http://pandoc.org) installed, although it's not a requirement.


See at CRAN