Learn R Programming

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

R.rsp (version 0.8.2)

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

15,887

Version

0.8.2

License

LGPL (>= 2.1)

Last Published

July 5th, 2012

Functions in R.rsp (0.8.2)

getComment.HtmlRspLanguage

Gets a comment string specifically for the HTML language
as.character.HttpRequest

Returns a short string describing the HTTP request
HttpDaemonRspResponse

The HttpDaemonRspResponse class
getVerbatim.HtmlRspLanguage

Gets a verbatim string specifically for the HTML language
escape.RspLanguage

Escapes a string specifically for a given RSP response language
getName.FileRspResponse

Gets the (base)name of the current RSP file
flush.RspResponse

Flushes the response buffer
indexOfNonQuoted

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

Starts the HTTP daemon and launches the specified URL
getPort.HttpDaemon

Gets the socket port of the HTTP daemon
RspResponse

The RspResponse class
Non-documented objects

Non-documented objects
FileRspResponse

The FileRspResponse class
RspLanguage

The RspLanguage class
as.character.HttpDaemon

Returns a short string describing the HTTP daemon
compileSweave

Compiles a Sweave file
getRemoteAddress.HttpRequest

Gets the IP address of the client that sent the request
R.rsp-package

Package R.rsp
getContentLength.HttpRequest

Gets the length of contents
getAbsolutePath.RspPage

Gets the absolute pathname to the current RSP file
RspPage

The RspPage class
getDefaultFilename.HttpDaemon

Gets the default filename to be loaded by the HTTP daemon
getHttpRequest.HttpDaemon

Gets the HTTP request
appendRootPaths.HttpDaemon

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

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

Flushes the buffer of an HttpDaemonRspResponse to the HttpDaemon
getConfig.HttpDaemon

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

Flushes the response buffer
getRemoteHost.HttpRequest

Gets the fully qualified name of the client that sent the request
getLanguage.RspLanguage

Gets the language string
importRsp

Imports an RSP file
getParameters.HttpRequest

Gets all parameters
getNewline.RspLanguage

Gets the newline string specific for a given RSP response language
getOutput.FileRspResponse

Gets the output for an RSP response
HtmlRspLanguage

The HtmlRspLanguage class
browseRsp

Starts the internal web browser and opens the URL in the default web browser
getPath.FileRspResponse

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

Checks if the HTTP daemon is started
getRealPath.HttpRequest

Gets the file system path for a given URI
getServerPort.HttpRequest

Gets the port number on which this request was received
getScheme.HttpRequest

Gets the scheme used to make this request
escape.HtmlRspLanguage

Escapes a string specifically for the HTML language
getName.RspPage

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

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

Gets a comment string specific for a given RSP response language
toLatex.character

Escapes character strings to become LaTeX compatible
startHelp.HttpDaemon

Starts the HTTP daemon and launches the help page
sourceRsp

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

Starts the HTTP daemon
processRsp.HttpDaemon

Processes an RSP page
stop.HttpDaemon

Stops the HTTP daemon
setRootPaths.HttpDaemon

Sets a new set of root directories for the HTTP daemon
translateRsp

Translates an RSP file to an R RSP source file
nbrOfParameters.HttpRequest

Gets the number of parameters
sourceAllRsp

Processes one or several RSP files
sourceTcl.HttpDaemon

Loads the Tcl source for the HTTP daemon into R
parseRsp

Parse an RSP code string to an R RSP code string
translateRspV1

Translates an RSP file to an R servlet
getContentType.HttpRequest

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

Gets the root directories of the HTTP daemon
rspToHtml

Compiles an RSP file to an HTML file
getPath.RspPage

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

Compiles a LaTeX file
getParameter.HttpRequest

Gets a parameter
getAbsolutePath.FileRspResponse

Gets the absolute pathname to the current RSP file
hasParameter.HttpRequest

Checks if a parameter exists
import.RspResponse

Imports the output from another RSP file
rsptex

Compiles an RSP LaTeX file into a DVI file
getVerbatim.RspLanguage

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

Restarts the HTTP daemon
write.RspResponse

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

Writes a string to the HTTP output connection
rsp

Compiles an RSP document
HttpDaemon

The HttpDaemon class
write.FileRspResponse

Writes an RSP response to the predefined output file
write.HttpDaemonRspResponse

Writes strings to an HttpDaemonRspResponse buffer
HttpRequest

The HttpRequest class