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


pipeline status
coverage report

CRAN_Status_Badge RStudio_downloads_monthly RStudio_downloads_total

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

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

News

excerptr 2.0.0

  • The package is refactored to now using reticualte instead of rPython. The now obsolete funtions get_excerpts() set_excertps_path() were removed.
  • Now using checkmate to check function arguments.

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

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

2.0.0 by Andreas Dominik Cullmann, 2 months 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 checkmate, reticulate

Suggests testthat, knitr, rmarkdown, devtools, RUnit, pkgload, rprojroot

System requirements: Python (>= 3.0.0)


See at CRAN