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

R.rsp (version 0.7.1)

Dynamic generation of scientific reports

Description

An RSP document is a text-based document containing an R-embedded template of the final document, e.g. "Today's date is <%=Sys.Date()%>". An RSP document is preprocessed, parsed and translated into an R script, which when sourced generates the final document. This way it is possible to dynamically generate reports in plain text, HTML, TeX etc, e.g. "\includegraphics{<%=toPDF('Normal', { curve(dnorm, from=-5, to=+5) })%>}". It can also be used to enhance other literate programming languages such as Sweave, e.g. "<>>= [...] @". As explained in one of the vignettes, RSP-embedded LaTeX vignettes can easily be included in any R package. In addition to RSP, this package also provides an internal cross-platform web server and built-in dynamic RSP-embedded HTML help pages, which can be launched by browseRsp(). If other packages provide RSP help pages, these are automatically linked to as well.

Copy Link

Version

Install

install.packages('R.rsp')

Monthly Downloads

35,584

Version

0.7.1

License

LGPL (>= 2.1)

Maintainer

Henrik Bengtsson

Last Published

January 12th, 2012

Functions in R.rsp (0.7.1)

HttpDaemon

The HttpDaemon class
getParameter.HttpRequest

Gets a parameter
HttpRequest

The HttpRequest class
browseRsp

Starts the internal web browser and opens the URL in the default web browser
getParameters.HttpRequest

Gets all parameters
flush.HttpDaemonRspResponse

Flushes the buffer of an HttpDaemonRspResponse to the HttpDaemon
getNewline.RspLanguage

Gets the newline string specific for a given RSP response language
getComment.HtmlRspLanguage

Gets a comment string specifically for the HTML language
HtmlRspLanguage

The HtmlRspLanguage class
R.rsp-package

Package R.rsp
getProtocol.HttpRequest

Gets the name and version of the protocol used to make this request
Non-documented objects

Non-documented objects
appendRootPaths.HttpDaemon

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

Gets the HTTP request
as.character.HttpRequest

Returns a short string describing the HTTP request
RspPage

The RspPage class
as.character.HttpDaemon

Returns a short string describing the HTTP daemon
nbrOfParameters.HttpRequest

Gets the number of parameters
getComment.RspLanguage

Gets a comment string specific for a given RSP response language
flush.RspResponse

Flushes the response buffer
getContentType.HttpRequest

Gets the MIME type of the body of the request
getConfig.HttpDaemon

Retrieves the server's 'config' structure from Tcl
FileRspResponse

The FileRspResponse class
translateRspV1

Translates an RSP file to an R servlet
compileSweave

Compiles a Sweave file
getDefaultFilename.HttpDaemon

Gets the default filename to be loaded by the HTTP daemon
getPath.FileRspResponse

Gets the path of the directory of the current RSP file
setRootPaths.HttpDaemon

Sets a new set of root directories for the HTTP daemon
getAbsolutePath.RspPage

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

Writes an RSP response to the predefined output file
getVerbatim.RspLanguage

Gets a verbatim string specific for a given RSP response language
restart.HttpDaemon

Restarts the HTTP daemon
compileLaTeX

Compiles a LaTeX file
rsp

Compiles an RSP document
translateRsp

Translates an RSP file to an R RSP source file
getName.RspPage

Gets the (base)name of the current RSP file
getRealPath.HttpRequest

Gets the file system path for a given URI
getVerbatim.HtmlRspLanguage

Gets a verbatim string specifically for the HTML language
hasParameter.HttpRequest

Checks if a parameter exists
startHelp.HttpDaemon

Starts the HTTP daemon and launches the help page
write.HttpDaemonRspResponse

Writes strings to an HttpDaemonRspResponse buffer
importRsp

Imports an RSP file
RspResponse

The RspResponse class
openUrl.HttpDaemon

Starts the HTTP daemon and launches the specified URL
getOutput.FileRspResponse

Gets the output for an RSP response
getName.FileRspResponse

Gets the (base)name of the current RSP file
getServerName.HttpRequest

Gets the host name of the server that revieved the request
flush.FileRspResponse

Flushes the response buffer
getServerPort.HttpRequest

Gets the port number on which this request was received
rsptex

Compiles an RSP LaTeX file into a DVI file
indexOfNonQuoted

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

Processes one or several RSP files
getRemoteHost.HttpRequest

Gets the fully qualified name of the client that sent the request
sourceTcl.HttpDaemon

Loads the Tcl source for the HTTP daemon into R
isStarted.HttpDaemon

Checks if the HTTP daemon is started
RspLanguage

The RspLanguage class
stop.HttpDaemon

Stops the HTTP daemon
start.HttpDaemon

Starts the HTTP daemon
getContentLength.HttpRequest

Gets the length of contents
write.RspResponse

Writes an RSP response to the predefined output file
processRsp.HttpDaemon

Processes an RSP page
escape.HtmlRspLanguage

Escapes a string specifically for the HTML language
getPath.RspPage

Gets the path of the directory of the current RSP file
getLanguage.RspLanguage

Gets the language string
import.RspResponse

Imports the output from another RSP file
escape.RspLanguage

Escapes a string specifically for a given RSP response language
sourceRsp

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

Gets the scheme used to make this request
getPort.HttpDaemon

Gets the socket port of the HTTP daemon
HttpDaemonRspResponse

The HttpDaemonRspResponse class
writeResponse.HttpDaemon

Writes a string to the HTTP output connection
parseRsp

Parse an RSP code string to an R RSP code string
rspToHtml

Compiles an RSP file to an HTML file
getRootPaths.HttpDaemon

Gets the root directories of the HTTP daemon
getRemoteAddress.HttpRequest

Gets the IP address of the client that sent the request
getAbsolutePath.FileRspResponse

Gets the absolute pathname to the current RSP file