Dynamic Generation of Scientific Reports
Subsets an RspDocument
Reads the content of a local or an online text file
Appends and inserts new paths to the list of known root directories
Returns a short string describing the HTTP daemon
Returns a short string describing the HTTP request
Returns a plain character string representation of an RSP string produ...
Recreates an RSP string from an RspConstruct
Starts the internal web browser and opens the URL in the default web b...
Compiles all TeX files into PDFs
Builds a non-Sweave Rnw vignette
Builds all non-Sweave Rnw vignette
Builds a package index HTML file
Builds a vignette
Checks which tools are supported
Compiles an AsciiDoc file
Compiles an AsciiDoc noweb file
Compiles a Knitr file
Compiles a LaTeX file
Compiles a Markdown file
Compiles a Rnw file
Compiles an RSP file
Compiles a Sweave file
Drops all empty RSP text constructs
Escapes a string specifically for a given RSP response language
Parses, translates, and evaluates the RSP document
Parses and evaluates the R code
Evaluates the shell (sh) code
Evaluates the source code
Parses, translates, and evaluates the RSP string
Translates an RspExpression into source code
The FileRspResponse class
Locates the asciidoc executable
Locates the pandoc executable
Locates a processor for an RSP product
Flattens an RspDocument
Flushes the response buffer
Gets the absolute pathname to the current RSP file
Gets the absolute pathname to the current RSP file
Gets and sets attributes of an object
Gets the source code
Gets the comment
Gets the comment of an RSP construct
Gets a comment string specific for a given RSP response language
Gets the source code header, body, and footer
Retrieves the server's 'config' structure from Tcl
Gets the content of the RSP eval directive
Gets the content of the RSP include directive
Gets the contents of the RSP text
Gets the length of contents
Gets the MIME type of the body of the request
Gets the default filename pattern to be loaded by the HTTP daemon
Checks whether the source code should be echoed or not
Gets the file attribute
Gets the file attribute
Gets the HTTP request
Checks whether an RSP construct will include text to the output or not
Gets the language string
Gets the language
Gets the (base)name of the current RSP file
Gets the (base)name of the current RSP file
Gets the newline string specific for a given RSP response language
Gets the output for an RSP response
Gets a parameter
Gets all parameters
Gets the path of the directory of the current RSP file
Gets the path to the source reference of an RSP string
Gets the path of the directory of the current RSP file
Gets the socket port of the HTTP daemon
Gets the name and version of the protocol used to make this request
Gets the file system path for a given URI
Gets the IP address of the client that sent the request
Gets the fully qualified name of the client that sent the request
Gets the root directories of the HTTP daemon
Gets the scheme used to make this request
Gets the host name of the server that reviewed the request
Gets the port number on which this request was received
Gets the source reference of an RSP document
Gets the source reference of an RSP string
Gets the suffix specifications
Gets the type of the RspDocument
Gets the content type
Gets the type of an RSP product
Gets the type of an RSP string
Checks if verbatim include should be used or not
Gets a verbatim string specific for a given RSP response language
Get the wrap length
Checks if a parameter exists
Checks whether a processor exist or not for an RSP product
The HtmlRspLanguage class
The HttpDaemon class
The HttpDaemonRspResponse class
The HttpRequest class
Gets the first index of a string that is not inside a double quoted st...
Checks if the HTTP daemon is started
Makes a RspSourceCode object
Merge neighboring 'text' elements
Gets the number of lines in an RSP string
Gets the number of parameters
Non-documented objects
Starts the HTTP daemon and launches the specified URL
Parses the R code
Parses the unknown RSP directive for its class
Parse an RSP string into and RSP document
Parses an RSP string into a RSP document
Parses the unknown RSP expression for its class
Parses the string into blocks of text and RSP
Parses an Rnw file
Locates and parses all vignettes
Processes all RSP preprocessing directives
Prints RSP arguments
Prints a summary of an RSP object
Processes an RSP file product
Processes an RSP page
Package R.rsp
Gets RSP arguments of an RSP document
Evaluates an RSP string and outputs the generated string
Compiles an RSP document into a preprocessed and validated RSP documen...
Compiles an RSP document and returns the generated source code script
Compiles an RSP document
Asserts that certain attributes exist
Restarts the HTTP daemon
Evaluates and postprocesses an RSP document and outputs the final RSP ...
The RRspPackage class
The RspCode class
The RspCodeChunk class
The RspComment class
The RspConstruct class
The RspCopyDirective class
The abstract RspDirective class
The RspDocument class
The RspErrorDirective class
The RspEvalDirective class
The RspException class
The RspExpression class
The RspFileProduct class
The RspIfDirective class
The RspIncludeDirective class
The RspLanguage class
The RspMetaDirective class
The abstract RspObject class
The RspPage class
The RspPageDirective class
The RspParser class
The RspProduct class
The RspResponse class
The RspRSourceCode class
The RspRSourceCodeFactory class
The RspShSourceCode class
The RspShSourceCodeFactory class
The RspSourceCode class
The RspSourceCodeFactory class
The RspString class
The RspStringProduct class
A tangle function for RSP documents
The RspText class
The RspUnknownDirective class
The RspUnparsedDirective class
The RspUnparsedExpression class
The RspVariableDirective class
The RspVoid class
A weave function for RSP documents
Evaluates an RSP string and returns the generated string
Sets a new set of root directories for the HTTP daemon
Loads the Tcl source for the HTTP daemon into R
Decomposes a URL into its components
Starts the HTTP daemon
Starts the HTTP daemon and launches the help page
Subsets an RspDocument
Drops all text-outputting calls from the source code
Terminates the HTTP daemon
Tidy up the RSP source code
Escapes character strings to become LaTeX compatible
Translates the RSP document into R source code
Parses and translates the RSP string into R code
Translates an RSP document to source code
Trims each of the RSP constructs
Trims all non-text RSP constructs
Checks whether an Rnw file is a Sweave or a knitr file
Views the RSP product
Writes a string to the HTTP output connection
Writes an RSP response to the predefined output
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.
Useful links