Learn R Programming

⚠️There's a newer version (0.46.0) of this package.Take me there.

R.rsp (version 0.9.17)

Dynamic generation of scientific reports

Description

The RSP markup language makes any text-based document come alive. RSP provides a powerful markup for controlling the content and output of LaTeX, HTML, Markdown, AsciiDoc, Sweave and knitr documents (and more), e.g. 'Today's date is <%=Sys.Date()%>'. Contrary to many other literate programming languages, with RSP it is straightforward to loop over mixtures of code and text sections, e.g. in month-by-month summaries. RSP has also several preprocessing directives for incorporating static and dynamic contents of external files (local or online) among other things. Functions rstring() and rcat() make it easy to process RSP strings, while rfile() compiles RSP files (also online) into their final outputs, e.g. rfile('report.tex.rsp') generates 'report.pdf'. RSP is ideal for self-contained scientific reports and R package vignettes.

Copy Link

Version

Install

install.packages('R.rsp')

Monthly Downloads

16,209

Version

0.9.17

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

July 29th, 2013

Functions in R.rsp (0.9.17)

exprToCode.RspSourceCodeFactory

Translates an RspExpression into source code

The RspCode class

The RspCodeChunk class

evaluate.RspDocument

Parses, translates, and evaluates the RSP document

The RspException class

The RRspPackage class

The HttpRequest class

The RspFileProduct class

as.character.HttpDaemon

Returns a short string describing the HTTP daemon

The abstract RspDirective class

The HttpDaemon class

parseRaw.RspParser

Parses the string into blocks of text and RSP

flush.RspResponse

Flushes the response buffer

FileRspResponse

The FileRspResponse class

Translates an RSP file to an R servlet

The RspDocument class

RspUnparsedDirective

The RspUnparsedDirective class

RspStringProduct

The RspStringProduct class

The RspIfDirective class

The RspProduct class

RspShSourceCodeFactory

The RspShSourceCodeFactory class

RspPageDirective

The RspPageDirective class

parse.RspParser

Parses the RSP string

The RspExpression class

RspMetaDirective

The RspMetaDirective class

Checks whether an Rnw file is a Sweave or a knitr file

HttpDaemonRspResponse

The HttpDaemonRspResponse class

Compiles an RSP document

Starts the internal web browser and opens the URL in the default web browser

findProcessor.RspProduct

Locates a processor for an RSP product

tidy.RspSourceCode

Tidy up the RSP source code

The RspRSourceCode class

Subsets an RspDocument

as.character.HttpRequest

Returns a short string describing the HTTP request

RspRSourceCodeFactory

The RspRSourceCodeFactory class

compileAsciiDocNoweb

Compiles an AsciiDoc noweb file

HttpDaemon$appendRootPaths

Appends and inserts new paths to the list of known root directories

Non-documented objects

Non-documented objects

compileAsciiDoc

Compiles an AsciiDoc file

HtmlRspLanguage

The HtmlRspLanguage class

evaluate.RspRSourceCode

Parses and evaluates the R code

RspErrorDirective

The RspErrorDirective class

RspIncludeDirective

The RspIncludeDirective class

RspShSourceCode

The RspShSourceCode class

The RspConstruct class

trim.RspDocument

Trims each of the RSP constructs

RspUnknownDirective

The RspUnknownDirective class

as.character.RspStringProduct

Returns a plain character string representation of an RSP string product

buildNonSweaveVignette

Builds a non-Sweave Rnw vignette

buildPkgIndexHtml

Builds a package index HTML file

HttpDaemon$start

Starts the HTTP daemon

buildNonSweaveVignettes

Builds all non-Sweave Rnw vignette

The RspText class

getAbsolutePath.FileRspResponse

Gets the absolute pathname to the current RSP file

The RspSourceCode class

getCode.RspCode

Gets the source code

The abstract RspObject class

HttpDaemon$getRootPaths

Gets the root directories of the HTTP daemon

getName.FileRspResponse

Gets the (base)name of the current RSP file

Compiles a LaTeX file

makeSourceCode.RspSourceCodeFactory

Makes a RspSourceCode object

getContent.RspIncludeDirective

Gets the content of the RSP include directive

getAttributes.RspObject

Gets the attributes of an RSP object

getSuffixSpecs.RspConstruct

Gets the suffix specifications

getVerbatim.RspIncludeDirective

Checks if verbatim include should be used or not

getContent.RspEvalDirective

Gets the content of the RSP eval directive

getPath.RspDocument

Gets the path to the source reference of an RSP string

hasProcessor.RspProduct

Checks whether a processor exist or not for an RSP product

buildNonSweaveTexToPdf

Compiles all TeX files into PDFs

The RspLanguage class

getServerName.HttpRequest

Gets the host name of the server that revieved the request

Decomposes a URL into its components

RspVariableDirective

The RspVariableDirective class

Compiles an RSP document

The RspComment class

HttpDaemon$sourceTcl

Loads the Tcl source for the HTTP daemon into R

getContentLength.HttpRequest

Gets the length of contents

getName.RspPage

Gets the (base)name of the current RSP file

getContent.RspText

Gets the contents of the RSP text

The RspString class

asRspString.RspConstruct

Recreates an RSP string from an RspConstruct

getNewline.RspLanguage

Gets the newline string specific for a given RSP response language

getContentType.HttpRequest

Gets the MIME type of the body of the request

getParameters.HttpRequest

Gets all parameters

RRspPackage$capabilitiesOf

Checks which tools are supported

Locates the asciidoc executable

Compiles an RSP file

getFile.RspIncludeDirective

Gets the file attribute

Builds a vignette

RspEvalDirective

The RspEvalDirective class

getType.RspPageDirective

Gets the content type

evaluate.RspString

Parses, translates, and evaluates the RSP string

escape.RspLanguage

Escapes a string specifically for a given RSP response language

RspUnparsedExpression

The RspUnparsedExpression class

parse.RspString

Parses the RSP string

getComment.RspComment

Gets the comment

Compiles an RSP LaTeX file into a DVI file

print.RspObject

Prints a summary of an RSP object

evaluate.RspSourceCode

Evaluates the source code

getInclude.RspConstruct

Checks whether an RSP construct will include text to the output or not

HttpDaemon$getConfig

Retrieves the server's 'config' structure from Tcl

Compiles a Knitr file

HttpDaemon$getPort

Gets the socket port of the HTTP daemon

getRemoteAddress.HttpRequest

Gets the IP address of the client that sent the request

getType.RspProduct

Gets the type of an RSP product

getLanguage.RspSourceCodeFactory

Gets the language

hasParameter.HttpRequest

Checks if a parameter exists

getEcho.RspCode

Checks whether the source code should be echoed or not

HttpDaemon$setRootPaths

Sets a new set of root directories for the HTTP daemon

print.RspArguments

Prints RSP arguments

getLanguage.RspLanguage

Gets the language string

Imports an RSP file

requireAttributes.RspDirective

Asserts that certain attributes exist

Evaluates an RSP string and outputs the generated string

getType.RspString

Gets the type of an RSP string

getSource.RspString

Gets the source reference of an RSP string

view.RspProduct

Views the RSP product

Locates the pandoc executable

nbrOfLines.RspString

Gets the number of lines in an RSP string

getFile.RspEvalDirective

Gets the file attribute

getPath.RspPage

Gets the path of the directory of the current RSP file

flatten.RspDocument

Flattens an RspDocument

getMetadata.RspDocument

Gets the metadata of the RspDocument

getSource.RspDocument

Gets the source reference of an RSP document

Compiles a Sweave file

Processes one or several RSP files

parse.RspRSourceCode

Parses the R code

dropEmptyText.RspDocument

Drops all empty RSP text constructs

getScheme.HttpRequest

Gets the scheme used to make this request

openUrl.HttpDaemon

Starts the HTTP daemon and launches the specified URL

trimNonText.RspDocument

Trims all non-text RSP constructs

getWrap.RspIncludeDirective

Get the wrap length

Evaluates and postprocesses an RSP document and outputs the final RSP document file

RspSourceCodeFactory

The RspSourceCodeFactory class

Parses an Rnw file

The RspResponse class

nbrOfParameters.HttpRequest

Gets the number of parameters

getVerbatim.RspLanguage

Gets a verbatim string specific for a given RSP response language

Compiles an RSP string and returns the generated source code script

The RspParser class

import.RspResponse

Imports the output from another RSP file

write.RspResponse

Writes an RSP response to the predefined output

getComment.RspConstruct

Gets the comment of an RSP construct

Compiles a Rnw file

process.RspProduct

Processes an RSP file product

A weave function for RSP documents

getComment.RspLanguage

Gets a comment string specific for a given RSP response language

toSourceCode.RspSourceCodeFactory

Translates an RSP document to source code

HttpDaemon$processRsp

Processes an RSP page

getAbsolutePath.RspPage

Gets the absolute pathname to the current RSP file

A tangle function for RSP documents

getType.RspDocument

Gets the type of the RspDocument

parse.RspUnparsedExpression

Parses the unknown RSP expression for its class

getParameter.HttpRequest

Gets a parameter

The RspPage class

getOutput.FileRspResponse

Gets the output for an RSP response

toR.RspDocument

Translates the RSP document into R source code

getCompleteCode.RspSourceCodeFactory

Gets the source code header, body, and footer

getMetadata.RspString

Gets the metadata of the RspDocument

Gets RSP arguments of an RSP document

startHelp.HttpDaemon

Starts the HTTP daemon and launches the help page

getRemoteHost.HttpRequest

Gets the fully qualified name of the client that sent the request

getPath.FileRspResponse

Gets the path of the directory of the current RSP file

parse.RspUnparsedDirective

Parses the unknown RSP directive for its class

HttpDaemon$isStarted

Checks if the HTTP daemon is started

Processes an RSP file by translating it to an R servlet, which is then sourced

Compiles an RSP document into a preprocessed and validated RSP document

Parses and translates the RSP string into R code

HttpDaemon$getDefaultFilenamePattern

Gets the default filename pattern to be loaded by the HTTP daemon

HttpDaemon$restart

Restarts the HTTP daemon

Locates and parses all vignettes

writeResponse.HttpDaemon

Writes a string to the HTTP output connection

tangle.RspSourceCode

Drops all text-outputting calls from the source code

compileMarkdown

Compiles a Markdown file

indexOfNonQuoted

Gets the first index of a string that is not inside a double qouted string

evaluate.RspShSourceCode

Evaluates the shell (sh) code

HttpDaemon$stop

Stops the HTTP daemon

getMetadata.RspProduct

Gets the metadata an RSP product

HttpDaemon$getHttpRequest

Gets the HTTP request

Parse an RSP code string to an R RSP code string

mergeTexts.RspDocument

Merge neighboring 'text' elements

Evaluates an RSP string and returns the generated string

preprocess.RspDocument

Processes all RSP preprocessing directives

Compiles an RSP file to an HTML file

Translates an RSP file to an R RSP source file

toLatex.character

Escapes character strings to become LaTeX compatible

getServerPort.HttpRequest

Gets the port number on which this request was received

getRealPath.HttpRequest

Gets the file system path for a given URI

subset.RspDocument

Subsets an RspDocument

getProtocol.HttpRequest

Gets the name and version of the protocol used to make this request