R.rsp v0.43.0


Monthly downloads



Dynamic Generation of Scientific Reports

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.

Functions in R.rsp

Name Description
RspCutDirective The RspCopyDirective class
RspCode The RspCode class
RRspPackage The RRspPackage class
RspStringProduct The RspStringProduct class
evaluate.RspDocument Parses, translates, and evaluates the RSP document
RspString The RspString class
buildNonSweaveVignette Builds a non-Sweave Rnw vignette
buildNonSweaveTexToPdf Compiles all TeX files into PDFs
evaluate.RspRSourceCode Parses and evaluates the R code
RspComment The RspComment class
HttpDaemonRspResponse The HttpDaemonRspResponse class
evaluate.RspShSourceCode Evaluates the shell (sh) code
evaluate.RspSourceCode Evaluates the source code
getAbsolutePath.RspPage Gets the absolute pathname to the current RSP file
RspConstruct The RspConstruct class
getAttributes.default Gets and sets attributes of an object
RspPageDirective The RspPageDirective class
RspCodeChunk The RspCodeChunk class
getContent.RspText Gets the contents of the RSP text
RspParser The RspParser class
RspDocument The RspDocument class
RspDirective The abstract RspDirective class
RspErrorDirective The RspErrorDirective class
getContentLength.HttpRequest Gets the length of contents
RspException The RspException class
RspRSourceCodeFactory The RspRSourceCodeFactory class
getPath.RspDocument Gets the path to the source reference of an RSP string
RspExpression The RspExpression class
RspLanguage The RspLanguage class
RspIfDirective The RspIfDirective class
RspResponse The RspResponse class
RspMetaDirective The RspMetaDirective class
RspFileProduct The RspFileProduct class
RspUnparsedDirective The RspUnparsedDirective class
RspUnparsedExpression The RspUnparsedExpression class
getPath.RspPage Gets the path of the directory of the current RSP file
RspSourceCode The RspSourceCode class
RspIncludeDirective The RspIncludeDirective class
getRealPath.HttpRequest Gets the file system path for a given URI
buildVignette Builds a vignette
getRemoteAddress.HttpRequest Gets the IP address of the client that sent the request
RspProduct The RspProduct class
nbrOfParameters.HttpRequest Gets the number of parameters
RspSourceCodeFactory The RspSourceCodeFactory class
as.character.HttpRequest Returns a short string describing the HTTP request
RspShSourceCode The RspShSourceCode class
RspShSourceCodeFactory The RspShSourceCodeFactory class
openUrl.HttpDaemon Starts the HTTP daemon and launches the specified URL
RspText The RspText class
RspUnknownDirective The RspUnknownDirective class
RRspPackage$capabilitiesOf Checks which tools are supported
as.character.RspStringProduct Returns a plain character string representation of an RSP string product
compileKnitr Compiles a Knitr file
RspObject The abstract RspObject class
RspRSourceCode The RspRSourceCode class
asRspString.RspConstruct Recreates an RSP string from an RspConstruct
compileAsciiDoc Compiles an AsciiDoc file
findProcessor.RspProduct Locates a processor for an RSP product
compileAsciiDocNoweb Compiles an AsciiDoc noweb file
browseRsp Starts the internal web browser and opens the URL in the default web browser
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
RspPage The RspPage class
RspVariableDirective The RspVariableDirective class
escape.RspLanguage Escapes a string specifically for a given RSP response language
dropEmptyText.RspDocument Drops all empty RSP text constructs
findAsciiDoc Locates the asciidoc executable
findPandoc Locates the pandoc executable
flatten.RspDocument Flattens an RspDocument
parseExpression.RspUnparsedExpression Parses the unknown RSP expression for its class
getContent.RspEvalDirective Gets the content of the RSP eval directive
getContent.RspIncludeDirective Gets the content of the RSP include directive
getCode.RspCode Gets the source code
getContentType.HttpRequest Gets the MIME type of the body of the request
compileRsp Compiles an RSP file
HttpDaemon$getDefaultFilenamePattern Gets the default filename pattern to be loaded by the HTTP daemon
compileSweave Compiles a Sweave file
parseRaw.RspParser Parses the string into blocks of text and RSP
RspVoid The RspVoid class
flush.RspResponse Flushes the response buffer
getOutput.FileRspResponse Gets the output for an RSP response
evaluate.RspString Parses, translates, and evaluates the RSP string
compileLaTeX Compiles a LaTeX file
getParameter.HttpRequest Gets a parameter
getParameters.HttpRequest Gets all parameters
getPath.FileRspResponse Gets the path of the directory of the current RSP file
getAbsolutePath.FileRspResponse Gets the absolute pathname to the current RSP file
buildNonSweaveVignettes Builds all non-Sweave Rnw vignette
getType.RspProduct Gets the type of an RSP product
rfile Evaluates and postprocesses an RSP document and outputs the final RSP document file
getComment.RspComment Gets the comment
getInclude.RspConstruct Checks whether an RSP construct will include text to the output or not
getType.RspString Gets the type of an RSP string
mergeTexts.RspDocument Merge neighboring 'text' elements
getLanguage.RspLanguage Gets the language string
exprToCode.RspSourceCodeFactory Translates an RspExpression into source code
nbrOfLines.RspString Gets the number of lines in an RSP string
rspTangle A tangle function for RSP documents
parseVignette Parses an Rnw file
HttpDaemon$getPort Gets the socket port of the HTTP daemon
getComment.RspConstruct Gets the comment of an RSP construct
buildPkgIndexHtml Builds a package index HTML file
tangle.RspSourceCode Drops all text-outputting calls from the source code
HttpDaemon$terminate Terminates the HTTP daemon
getLanguage.RspSourceCodeFactory Gets the language
getProtocol.HttpRequest Gets the name and version of the protocol used to make this request
view.RspProduct Views the RSP product
getName.FileRspResponse Gets the (base)name of the current RSP file
parseVignettes Locates and parses all vignettes
getRemoteHost.HttpRequest Gets the fully qualified name of the client that sent the request
writeResponse.HttpDaemon Writes a string to the HTTP output connection
getComment.RspLanguage Gets a comment string specific for a given RSP response language
rcode Compiles an RSP document and returns the generated source code script
rcompile Compiles an RSP document
getVerbatim.RspIncludeDirective Checks if verbatim include should be used or not
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
HttpDaemon$getRootPaths Gets the root directories of the HTTP daemon
trimNonText.RspDocument Trims all non-text RSP constructs
getWrap.RspIncludeDirective Get the wrap length
typeOfRnw Checks whether an Rnw file is a Sweave or a knitr file
hasParameter.HttpRequest Checks if a parameter exists
compileMarkdown Compiles a Markdown file
getEcho.RspCode Checks whether the source code should be echoed or not
compileRnw Compiles a Rnw file
parseCode.RspRSourceCode Parses the R code
getVerbatim.RspLanguage Gets a verbatim string specific for a given RSP response language
getCompleteCode.RspSourceCodeFactory Gets the source code header, body, and footer
HttpDaemon$isStarted Checks if the HTTP daemon is started
makeSourceCode.RspSourceCodeFactory Makes a RspSourceCode object
getFile.RspEvalDirective Gets the file attribute
splitUrl Decomposes a URL into its components
getServerPort.HttpRequest Gets the port number on which this request was received
HttpDaemon$getConfig Retrieves the server's 'config' structure from Tcl
getFile.RspIncludeDirective Gets the file attribute
parseDirective.RspUnparsedDirective Parses the unknown RSP directive for its class
HttpDaemon$start Starts the HTTP daemon
HttpDaemon$getHttpRequest Gets the HTTP request
preprocess.RspDocument Processes all RSP preprocessing directives
print.RspArguments Prints RSP arguments
requireAttributes.RspDirective Asserts that certain attributes exist
getSource.RspDocument Gets the source reference of an RSP document
HttpDaemon$restart Restarts the HTTP daemon
writeResponse.RspResponse Writes an RSP response to the predefined output
getSource.RspString Gets the source reference of an RSP string
getSuffixSpecs.RspConstruct Gets the suffix specifications
getName.RspPage Gets the (base)name of the current RSP file
process.RspProduct Processes an RSP file product
print.RspObject Prints a summary of an RSP object
getNewline.RspLanguage Gets the newline string specific for a given RSP response language
getScheme.HttpRequest Gets the scheme used to make this request
getServerName.HttpRequest Gets the host name of the server that reviewed the request
HttpDaemon$processRsp Processes an RSP page
rargs Gets RSP arguments of an RSP document
getType.RspDocument Gets the type of the RspDocument
rspWeave A weave function for RSP documents
startHelp.HttpDaemon Starts the HTTP daemon and launches the help page
rstring Evaluates an RSP string and returns the generated string
getType.RspPageDirective Gets the content type
toR.RspDocument Translates the RSP document into R source code
toR.RspString Parses and translates the RSP string into R code
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 quoted string
subset.RspDocument Subsets an RspDocument
parseDocument.RspParser Parse an RSP string into and RSP document
toLatex.character Escapes character strings to become LaTeX compatible
tidy.RspSourceCode Tidy up the RSP source code
parseDocument.RspString Parses an RSP string into a RSP document
rcat Evaluates an RSP string and outputs the generated string
rclean Compiles an RSP document into a preprocessed and validated RSP document
toSourceCode.RspSourceCodeFactory Translates an RSP document to source code
trim.RspDocument Trims each of the RSP constructs
HttpDaemon The HttpDaemon class
R.rsp-package Package R.rsp
HttpRequest The HttpRequest class
Non-documented objects Non-documented objects
RspEvalDirective The RspEvalDirective class
FileRspResponse The FileRspResponse class
HtmlRspLanguage The HtmlRspLanguage class
.readText Reads the content of a local or an online text file
[.RspDocument Subsets an RspDocument
No Results!

Vignettes of R.rsp

No Results!

Last month downloads


SuggestsNote Recommended: R.devices, base64enc, markdown
VignetteBuilder R.rsp
Date 2018-08-25
License LGPL (>= 2.1)
URL https://github.com/HenrikBengtsson/R.rsp
BugReports https://github.com/HenrikBengtsson/R.rsp/issues
LazyLoad TRUE
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2018-08-26 06:11:11 UTC; hb
Repository CRAN
Date/Publication 2018-08-26 06:44:22 UTC

Include our badge in your README