Build Status Coverage Status CRAN_Status_Badge RStudio_downloads_monthly RStudio_downloads_total

excerptr

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, then install excerptr from CRAN

install.packages("excerptr")

Windows

rPython-win

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

rPython-win for Folks at fvafr

Should you happen to be one of my colleagues at fvafr, please follow these instructions.

excerptr

Then get the excerptr source from github, edit the file DESCRIPTION and remove the line reading OS_type: unix and install the package manually:

local_directory <- tempdir()
local_path <- file.path(local_directory, "master.zip")
url <- "https://github.com/fvafrCU/excerptr/archive/master.zip"
download.file(url, local_path, method = "wininet", mode = "wb")
unzip(local_path, exdir = local_directory)
excerptr_path <- file.path(local_directory, "excerptr-master")
description <- file.path(excerptr_path, "DESCRIPTION")
my_r_version <- paste(R.Version()[["major"]], R.Version()[["minor"]], sep = ".")
d <- readLines(description)
d1 <- d[-grep("^OS_type:", d)]
d1[grep("^ *R \\(", d1)] <- paste0("    R (>= ", my_r_version,")")
writeLines(d1, description)
if (! require("rprojroot")) install.packages("rprojroot")
install.packages(excerptr_path, repos = NULL, type = "source")