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

R.rsp (version 0.41.0)

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, rsource() sources an RSP file as it was an R script, while rfile() compiles it (even online) into its final output format, e.g. rfile('report.tex.rsp') generates 'report.pdf' and rfile('report.md.rsp') generates 'report.html'. RSP is ideal for self-contained scientific reports and R package vignettes. It's easy to use - if you know how to write an R script, you'll be up and running within minutes.

Copy Link

Version

Install

install.packages('R.rsp')

Monthly Downloads

15,887

Version

0.41.0

License

LGPL (>= 2.1)

Issues

12

Pull Requests

0

Stars

31

Forks

6

Maintainer

Henrik Bengtsson

Last Published

April 16th, 2017

Functions in R.rsp (0.41.0)

R.rsp-package

Package R.rsp
RRspPackage

The RRspPackage class
RspDocument

The RspDocument class
RspErrorDirective

The RspErrorDirective class
RspPageDirective

The RspPageDirective class
RspParser

The RspParser class
RspProduct

The RspProduct class
RspRSourceCode

The RspRSourceCode class
RspText

The RspText class
RspUnknownDirective

The RspUnknownDirective class
evaluate.RspDocument

Parses, translates, and evaluates the RSP document
evaluate.RspRSourceCode

Parses and evaluates the R code
evaluate.RspShSourceCode

Evaluates the shell (sh) code
evaluate.RspSourceCode

Evaluates the source code
getCode.RspCode

Gets the source code
getComment.RspComment

Gets the comment
getOutput.FileRspResponse

Gets the output for an RSP response
getParameter.HttpRequest

Gets a parameter
getScheme.HttpRequest

Gets the scheme used to make this request
getServerName.HttpRequest

Gets the host name of the server that revieved the request
getWrap.RspIncludeDirective

Get the wrap length
hasParameter.HttpRequest

Checks if a parameter exists
hasProcessor.RspProduct

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

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

Processes all RSP preprocessing directives
print.RspArguments

Prints RSP arguments
rcode

Compiles an RSP document and returns the generated source code script
rcompile

Compiles an RSP document
view.RspProduct

Views the RSP product
write.RspResponse

Writes an RSP response to the predefined output
RspCutDirective

The RspCopyDirective class
RspDirective

The abstract RspDirective class
RspIfDirective

The RspIfDirective class
RspIncludeDirective

The RspIncludeDirective class
RspString

The RspString class
RspStringProduct

The RspStringProduct class
buildVignette

Builds a vignette
RRspPackage$capabilitiesOf

Checks which tools are supported
flush.RspResponse

Flushes the response buffer
getAbsolutePath.FileRspResponse

Gets the absolute pathname to the current RSP file
HttpDaemon$getPort

Gets the socket port of the HTTP daemon
getProtocol.HttpRequest

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

Checks if verbatim include should be used or not
getVerbatim.RspLanguage

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

Parses the RSP string
parse.RspUnparsedDirective

Parses the unknown RSP directive for its class
HttpDaemon$processRsp

Processes an RSP page
rargs

Gets RSP arguments of an RSP document
splitUrl

Decomposes a URL into its components
HttpDaemon$start

Starts the HTTP daemon
trimNonText.RspDocument

Trims all non-text RSP constructs
typeOfRnw

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

The RspVariableDirective class
RspVoid

The RspVoid class
buildNonSweaveVignettes

Builds all non-Sweave Rnw vignette
buildPkgIndexHtml

Builds a package index HTML file
compileMarkdown

Compiles a Markdown file
compileRnw

Compiles a Rnw file
getComment.RspConstruct

Gets the comment of an RSP construct
getComment.RspLanguage

Gets a comment string specific for a given RSP response language
getInclude.RspConstruct

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

Gets the language string
FileRspResponse

The FileRspResponse class
getRealPath.HttpRequest

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

Gets the IP address of the client that sent the request
getType.RspProduct

Gets the type of an RSP product
getType.RspString

Gets the type of an RSP string
HtmlRspLanguage

The HtmlRspLanguage class
RspEvalDirective

The RspEvalDirective class
RspException

The RspException class
RspRSourceCodeFactory

The RspRSourceCodeFactory class
RspResponse

The RspResponse class
RspUnparsedDirective

The RspUnparsedDirective class
RspUnparsedExpression

The RspUnparsedExpression class
parse.RspParser

Parses the RSP string
parse.RspRSourceCode

Parses the R code
print.RspObject

Prints a summary of an RSP object
process.RspProduct

Processes an RSP file product
asRspString.RspConstruct

Recreates an RSP string from an RspConstruct
browseRsp

Starts the internal web browser and opens the URL in the default web browser
findProcessor.RspProduct

Locates a processor for an RSP product
flatten.RspDocument

Flattens an RspDocument
getAbsolutePath.RspPage

Gets the absolute pathname to the current RSP file
getAttributes.default

Gets and sets attributes of an object
startHelp.HttpDaemon

Starts the HTTP daemon and launches the help page
HttpDaemon$stop

Stops the HTTP daemon
getContent.RspText

Gets the contents of the RSP text
getContentLength.HttpRequest

Gets the length of contents
getType.RspDocument

Gets the type of the RspDocument
getType.RspPageDirective

Gets the content type
HttpDaemon

The HttpDaemon class
HttpDaemonRspResponse

The HttpDaemonRspResponse class
RspComment

The RspComment class
RspConstruct

The RspConstruct class
HttpDaemon$isStarted

Checks if the HTTP daemon is started
makeSourceCode.RspSourceCodeFactory

Makes a RspSourceCode object
tidy.RspSourceCode

Tidy up the RSP source code
toLatex.character

Escapes character strings to become LaTeX compatible
RspExpression

The RspExpression class
RspFileProduct

The RspFileProduct class
RspObject

The abstract RspObject class
dropEmptyText.RspDocument

Drops all empty RSP text constructs
escape.RspLanguage

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

Gets the (base)name of the current RSP file
getNewline.RspLanguage

Gets the newline string specific for a given RSP response language
mergeTexts.RspDocument

Merge neighboring 'text' elements
nbrOfLines.RspString

Gets the number of lines in an RSP string
compileKnitr

Compiles a Knitr file
compileLaTeX

Compiles a LaTeX file
RspPage

The RspPage class
HttpDaemon$appendRootPaths

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

Returns a short string describing the HTTP daemon
[.RspDocument

Subsets an RspDocument
.readText

Reads the content of a local or an online text file
rcat

Evaluates an RSP string and outputs the generated string
rclean

Compiles an RSP document into a preprocessed and validated RSP document
getContent.RspEvalDirective

Gets the content of the RSP eval directive
getContent.RspIncludeDirective

Gets the content of the RSP include directive
getContentType.HttpRequest

Gets the MIME type of the body of the request
RspCode

The RspCode class
RspCodeChunk

The RspCodeChunk class
RspLanguage

The RspLanguage class
rspWeave

A weave function for RSP documents
rstring

Evaluates an RSP string and returns the generated string
RspMetaDirective

The RspMetaDirective class
RspSourceCode

The RspSourceCode class
RspSourceCodeFactory

The RspSourceCodeFactory class
as.character.HttpRequest

Returns a short string describing the HTTP request
nbrOfParameters.HttpRequest

Gets the number of parameters
openUrl.HttpDaemon

Starts the HTTP daemon and launches the specified URL
parseVignette

Parses an Rnw file
parseVignettes

Locates and parses all vignettes
rfile

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

A tangle function for RSP documents
as.character.RspStringProduct

Returns a plain character string representation of an RSP string product
compileAsciiDoc

Compiles an AsciiDoc file
compileAsciiDocNoweb

Compiles an AsciiDoc noweb file
HttpDaemon$getDefaultFilenamePattern

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

Gets the path to the source reference of an RSP string
getPath.RspPage

Gets the path of the directory of the current RSP file
getServerPort.HttpRequest

Gets the port number on which this request was received
getSource.RspDocument

Gets the source reference of an RSP document
getSource.RspString

Gets the source reference of an RSP string
getSuffixSpecs.RspConstruct

Gets the suffix specifications
findAsciiDoc

Locates the asciidoc executable
findPandoc

Locates the pandoc executable
getFile.RspIncludeDirective

Gets the file attribute
HttpDaemon$getHttpRequest

Gets the HTTP request
subset.RspDocument

Subsets an RspDocument
tangle.RspSourceCode

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

Translates the RSP document into R source code
HttpRequest

The HttpRequest class
Non-documented objects

Non-documented objects
RspShSourceCode

The RspShSourceCode class
RspShSourceCodeFactory

The RspShSourceCodeFactory class
buildNonSweaveTexToPdf

Compiles all TeX files into PDFs
buildNonSweaveVignette

Builds a non-Sweave Rnw vignette
compileRsp

Compiles an RSP file
getLanguage.RspSourceCodeFactory

Gets the language
getName.FileRspResponse

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

Gets the fully qualified name of the client that sent the request
HttpDaemon$getRootPaths

Gets the root directories of the HTTP daemon
parse.RspUnparsedExpression

Parses the unknown RSP expression for its class
parseRaw.RspParser

Parses the string into blocks of text and RSP
writeResponse.HttpDaemon

Writes a string to the HTTP output connection
toR.RspString

Parses and translates the RSP string into R code
compileSweave

Compiles a Sweave file
evaluate.RspString

Parses, translates, and evaluates the RSP string
exprToCode.RspSourceCodeFactory

Translates an RspExpression into source code
getCompleteCode.RspSourceCodeFactory

Gets the source code header, body, and footer
HttpDaemon$getConfig

Retrieves the server's 'config' structure from Tcl
getEcho.RspCode

Checks whether the source code should be echoed or not
getFile.RspEvalDirective

Gets the file attribute
getParameters.HttpRequest

Gets all parameters
getPath.FileRspResponse

Gets the path of the directory of the current RSP file
requireAttributes.RspDirective

Asserts that certain attributes exist
HttpDaemon$restart

Restarts the HTTP daemon
HttpDaemon$setRootPaths

Sets a new set of root directories for the HTTP daemon
HttpDaemon$sourceTcl

Loads the Tcl source for the HTTP daemon into R
toSourceCode.RspSourceCodeFactory

Translates an RSP document to source code
trim.RspDocument

Trims each of the RSP constructs