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

R.rsp (version 0.9.28)

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

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

October 15th, 2013

Functions in R.rsp (0.9.28)

getMetadata.RspDocument

Gets the metadata of the RspDocument
compileAsciiDoc

Compiles an AsciiDoc file
FileRspResponse

The FileRspResponse class
RspPageDirective

The RspPageDirective class
Non-documented objects

Non-documented objects
buildVignette

Builds a vignette
HttpDaemon

The HttpDaemon class
RspPage

The RspPage class
getNewline.RspLanguage

Gets the newline string specific for a given RSP response language
as.character.HttpRequest

Returns a short string describing the HTTP request
RspProduct

The RspProduct class
RspEvalDirective

The RspEvalDirective class
RspDocument

The RspDocument class
HttpDaemon$getDefaultFilenamePattern

Gets the default filename pattern to be loaded by the HTTP daemon
[.RspDocument

Subsets an RspDocument
RspException

The RspException class
RspParser

The RspParser class
getCompleteCode.RspSourceCodeFactory

Gets the source code header, body, and footer
HttpRequest

The HttpRequest class
RspResponse

The RspResponse class
RspVariableDirective

The RspVariableDirective class
RspIfDirective

The RspIfDirective class
RspDirective

The abstract RspDirective class
RspShSourceCodeFactory

The RspShSourceCodeFactory class
RspObject

The abstract RspObject class
getMetadata.RspProduct

Gets the metadata an RSP product
compileSweave

Compiles a Sweave file
getPath.FileRspResponse

Gets the path of the directory of the current RSP file
RspConstruct

The RspConstruct class
getProtocol.HttpRequest

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

Compiles an RSP file
evaluate.RspString

Parses, translates, and evaluates the RSP string
getFile.RspEvalDirective

Gets the file attribute
evaluate.RspShSourceCode

Evaluates the shell (sh) code
RspComment

The RspComment class
asRspString.RspConstruct

Recreates an RSP string from an RspConstruct
RspStringProduct

The RspStringProduct class
compileMarkdown

Compiles a Markdown file
getSuffixSpecs.RspConstruct

Gets the suffix specifications
findPandoc

Locates the pandoc executable
buildNonSweaveVignette

Builds a non-Sweave Rnw vignette
getName.RspPage

Gets the (base)name of the current RSP file
compileRnw

Compiles a Rnw file
RspUnparsedExpression

The RspUnparsedExpression class
RspCodeChunk

The RspCodeChunk class
getAbsolutePath.RspPage

Gets the absolute pathname to the current RSP file
getAbsolutePath.FileRspResponse

Gets the absolute pathname to the current RSP file
buildNonSweaveVignettes

Builds all non-Sweave Rnw vignette
as.character.HttpDaemon

Returns a short string describing the HTTP daemon
RspCode

The RspCode class
RspText

The RspText class
buildNonSweaveTexToPdf

Compiles all TeX files into PDFs
parseRaw.RspParser

Parses the string into blocks of text and RSP
HttpDaemonRspResponse

The HttpDaemonRspResponse class
RRspPackage

The RRspPackage class
getServerName.HttpRequest

Gets the host name of the server that revieved the request
compileLaTeX

Compiles a LaTeX file
importRsp

Imports an RSP file
buildPkgIndexHtml

Builds a package index HTML file
dropEmptyText.RspDocument

Drops all empty RSP text constructs
rargs

Gets RSP arguments of an RSP document
HtmlRspLanguage

The HtmlRspLanguage class
getPath.RspDocument

Gets the path to the source reference of an RSP string
HttpDaemon$getConfig

Retrieves the server's 'config' structure from Tcl
getWrap.RspIncludeDirective

Get the wrap length
getCode.RspCode

Gets the source code
RspSourceCode

The RspSourceCode class
evaluate.RspDocument

Parses, translates, and evaluates the RSP document
writeResponse.HttpDaemon

Writes a string to the HTTP output connection
RRspPackage$capabilitiesOf

Checks which tools are supported
getEcho.RspCode

Checks whether the source code should be echoed or not
RspIncludeDirective

The RspIncludeDirective class
getScheme.HttpRequest

Gets the scheme used to make this request
RspErrorDirective

The RspErrorDirective class
RspLanguage

The RspLanguage class
as.character.RspStringProduct

Returns a plain character string representation of an RSP string product
getRemoteAddress.HttpRequest

Gets the IP address of the client that sent the request
evaluate.RspRSourceCode

Parses and evaluates the R code
flush.RspResponse

Flushes the response buffer
R.rsp-package

Package R.rsp
browseRsp

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

The RspFileProduct class
RspRSourceCodeFactory

The RspRSourceCodeFactory class
getType.RspPageDirective

Gets the content type
rcat

Evaluates an RSP string and outputs the generated string
RspShSourceCode

The RspShSourceCode class
getPath.RspPage

Gets the path of the directory of the current RSP file
RspMetaDirective

The RspMetaDirective class
getInclude.RspConstruct

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

Starts the HTTP daemon
HttpDaemon$sourceTcl

Loads the Tcl source for the HTTP daemon into R
compileAsciiDocNoweb

Compiles an AsciiDoc noweb file
RspString

The RspString class
RspUnknownDirective

The RspUnknownDirective class
RspExpression

The RspExpression class
HttpDaemon$stop

Stops the HTTP daemon
hasParameter.HttpRequest

Checks if a parameter exists
HttpDaemon$getPort

Gets the socket port of the HTTP daemon
getServerPort.HttpRequest

Gets the port number on which this request was received
RspRSourceCode

The RspRSourceCode class
RspSourceCodeFactory

The RspSourceCodeFactory class
toR.RspDocument

Translates the RSP document into R source code
getRemoteHost.HttpRequest

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

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

A tangle function for RSP documents
startHelp.HttpDaemon

Starts the HTTP daemon and launches the help page
exprToCode.RspSourceCodeFactory

Translates an RspExpression into source code
escape.RspLanguage

Escapes a string specifically for a given RSP response language
translateRsp

Translates an RSP file to an R RSP source file
trimNonText.RspDocument

Trims all non-text RSP constructs
HttpDaemon$appendRootPaths

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

Compiles a Knitr file
evaluate.RspSourceCode

Evaluates the source code
flatten.RspDocument

Flattens an RspDocument
getRealPath.HttpRequest

Gets the file system path for a given URI
getComment.RspConstruct

Gets the comment of an RSP construct
getLanguage.RspLanguage

Gets the language string
parse.RspRSourceCode

Parses the R code
toSourceCode.RspSourceCodeFactory

Translates an RSP document to source code
toR.RspString

Parses and translates the RSP string into R code
getSource.RspDocument

Gets the source reference of an RSP document
splitUrl

Decomposes a URL into its components
getFile.RspIncludeDirective

Gets the file attribute
write.RspResponse

Writes an RSP response to the predefined output
getLanguage.RspSourceCodeFactory

Gets the language
HttpDaemon$getRootPaths

Gets the root directories of the HTTP daemon
getType.RspDocument

Gets the type of the RspDocument
nbrOfParameters.HttpRequest

Gets the number of parameters
rspToHtml

Compiles an RSP file to an HTML file
getContentType.HttpRequest

Gets the MIME type of the body of the request
tangle.RspSourceCode

Drops all text-outputting calls from the source code
trim.RspDocument

Trims each of the RSP constructs
getSource.RspString

Gets the source reference of an RSP string
getOutput.FileRspResponse

Gets the output for an RSP response
getContent.RspText

Gets the contents of the RSP text
process.RspProduct

Processes an RSP file product
mergeTexts.RspDocument

Merge neighboring 'text' elements
view.RspProduct

Views the RSP product
getVerbatim.RspIncludeDirective

Checks if verbatim include should be used or not
sourceAllRsp

Processes one or several RSP files
parseRsp

Parse an RSP code string to an R RSP code string
findProcessor.RspProduct

Locates a processor for an RSP product
parseVignettes

Locates and parses all vignettes
HttpDaemon$isStarted

Checks if the HTTP daemon is started
getType.RspString

Gets the type of an RSP string
nbrOfLines.RspString

Gets the number of lines in an RSP string
hasProcessor.RspProduct

Checks whether a processor exist or not for an RSP product
RspUnparsedDirective

The RspUnparsedDirective class
rclean

Compiles an RSP document into a preprocessed and validated RSP document
rsp

Compiles an RSP document
getType.RspProduct

Gets the type of an RSP product
findAsciiDoc

Locates the asciidoc executable
getParameter.HttpRequest

Gets a parameter
getAttributes.RspObject

Gets the attributes of an RSP object
parse.RspParser

Parses the RSP string
rcompile

Compiles an RSP document
tidy.RspSourceCode

Tidy up the RSP source code
parse.RspUnparsedExpression

Parses the unknown RSP expression for its class
getContent.RspEvalDirective

Gets the content of the RSP eval directive
HttpDaemon$processRsp

Processes an RSP page
getContent.RspIncludeDirective

Gets the content of the RSP include directive
parse.RspUnparsedDirective

Parses the unknown RSP directive for its class
getParameters.HttpRequest

Gets all parameters
getComment.RspComment

Gets the comment
getVerbatim.RspLanguage

Gets a verbatim string specific for a given RSP response language
getName.FileRspResponse

Gets the (base)name of the current RSP file
rstring

Evaluates an RSP string and returns the generated string
rfile

Evaluates and postprocesses an RSP document and outputs the final RSP document file
HttpDaemon$restart

Restarts the HTTP daemon
requireAttributes.RspDirective

Asserts that certain attributes exist
print.RspArguments

Prints RSP arguments
getMetadata.RspString

Gets the metadata of the RspDocument
rsptex

Compiles an RSP LaTeX file into a DVI file
parseVignette

Parses an Rnw file
rscript

Compiles an RSP string and returns the generated source code script
getComment.RspLanguage

Gets a comment string specific for a given RSP response language
parse.RspString

Parses the RSP string
preprocess.RspDocument

Processes all RSP preprocessing directives
HttpDaemon$getHttpRequest

Gets the HTTP request
makeSourceCode.RspSourceCodeFactory

Makes a RspSourceCode object
getContentLength.HttpRequest

Gets the length of contents
toLatex.character

Escapes character strings to become LaTeX compatible
translateRspV1

Translates an RSP file to an R servlet
import.RspResponse

Imports the output from another RSP file
rspWeave

A weave function for RSP documents
HttpDaemon$setRootPaths

Sets a new set of root directories for the HTTP daemon
print.RspObject

Prints a summary of an RSP object
subset.RspDocument

Subsets an RspDocument
sourceRsp

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

Checks whether an Rnw file is a Sweave or a knitr file
openUrl.HttpDaemon

Starts the HTTP daemon and launches the specified URL