R.rsp v0.9.17
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, while rfile() compiles RSP files (also online) into their final outputs, e.g. rfile('report.tex.rsp') generates 'report.pdf'. RSP is ideal for self-contained scientific reports and R package vignettes.
Functions in R.rsp
| Name | Description | |
| exprToCode.RspSourceCodeFactory | Translates an RspExpression into source code | |
| RspCode | The RspCode class | |
| RspCodeChunk | The RspCodeChunk class | |
| evaluate.RspDocument | Parses, translates, and evaluates the RSP document | |
| RspException | The RspException class | |
| RRspPackage | The RRspPackage class | |
| HttpRequest | The HttpRequest class | |
| RspFileProduct | The RspFileProduct class | |
| as.character.HttpDaemon | Returns a short string describing the HTTP daemon | |
| RspDirective | The abstract RspDirective class | |
| HttpDaemon | The HttpDaemon class | |
| parseRaw.RspParser | Parses the string into blocks of text and RSP | |
| flush.RspResponse | Flushes the response buffer | |
| FileRspResponse | The FileRspResponse class | |
| translateRspV1 | Translates an RSP file to an R servlet | |
| RspDocument | The RspDocument class | |
| RspUnparsedDirective | The RspUnparsedDirective class | |
| RspStringProduct | The RspStringProduct class | |
| RspIfDirective | The RspIfDirective class | |
| RspProduct | The RspProduct class | |
| RspShSourceCodeFactory | The RspShSourceCodeFactory class | |
| RspPageDirective | The RspPageDirective class | |
| parse.RspParser | Parses the RSP string | |
| RspExpression | The RspExpression class | |
| RspMetaDirective | The RspMetaDirective class | |
| typeOfRnw | Checks whether an Rnw file is a Sweave or a knitr file | |
| HttpDaemonRspResponse | The HttpDaemonRspResponse class | |
| rcompile | Compiles an RSP document | |
| browseRsp | Starts the internal web browser and opens the URL in the default web browser | |
| findProcessor.RspProduct | Locates a processor for an RSP product | |
| tidy.RspSourceCode | Tidy up the RSP source code | |
| RspRSourceCode | The RspRSourceCode class | |
| [.RspDocument | Subsets an RspDocument | |
| as.character.HttpRequest | Returns a short string describing the HTTP request | |
| RspRSourceCodeFactory | The RspRSourceCodeFactory class | |
| compileAsciiDocNoweb | Compiles an AsciiDoc noweb file | |
| HttpDaemon$appendRootPaths | Appends and inserts new paths to the list of known root directories | |
| Non-documented objects | Non-documented objects | |
| compileAsciiDoc | Compiles an AsciiDoc file | |
| HtmlRspLanguage | The HtmlRspLanguage class | |
| evaluate.RspRSourceCode | Parses and evaluates the R code | |
| RspErrorDirective | The RspErrorDirective class | |
| RspIncludeDirective | The RspIncludeDirective class | |
| RspShSourceCode | The RspShSourceCode class | |
| RspConstruct | The RspConstruct class | |
| trim.RspDocument | Trims each of the RSP constructs | |
| RspUnknownDirective | The RspUnknownDirective class | |
| as.character.RspStringProduct | Returns a plain character string representation of an RSP string product | |
| buildNonSweaveVignette | Builds a non-Sweave Rnw vignette | |
| buildPkgIndexHtml | Builds a package index HTML file | |
| HttpDaemon$start | Starts the HTTP daemon | |
| buildNonSweaveVignettes | Builds all non-Sweave Rnw vignette | |
| RspText | The RspText class | |
| getAbsolutePath.FileRspResponse | Gets the absolute pathname to the current RSP file | |
| RspSourceCode | The RspSourceCode class | |
| getCode.RspCode | Gets the source code | |
| RspObject | The abstract RspObject class | |
| HttpDaemon$getRootPaths | Gets the root directories of the HTTP daemon | |
| getName.FileRspResponse | Gets the (base)name of the current RSP file | |
| compileLaTeX | Compiles a LaTeX file | |
| makeSourceCode.RspSourceCodeFactory | Makes a RspSourceCode object | |
| getContent.RspIncludeDirective | Gets the content of the RSP include directive | |
| getAttributes.RspObject | Gets the attributes of an RSP object | |
| getSuffixSpecs.RspConstruct | Gets the suffix specifications | |
| getVerbatim.RspIncludeDirective | Checks if verbatim include should be used or not | |
| getContent.RspEvalDirective | Gets the content of the RSP eval directive | |
| getPath.RspDocument | Gets the path to the source reference of an RSP string | |
| hasProcessor.RspProduct | Checks whether a processor exist or not for an RSP product | |
| buildNonSweaveTexToPdf | Compiles all TeX files into PDFs | |
| RspLanguage | The RspLanguage class | |
| getServerName.HttpRequest | Gets the host name of the server that revieved the request | |
| splitUrl | Decomposes a URL into its components | |
| RspVariableDirective | The RspVariableDirective class | |
| rsp | Compiles an RSP document | |
| RspComment | The RspComment class | |
| HttpDaemon$sourceTcl | Loads the Tcl source for the HTTP daemon into R | |
| getContentLength.HttpRequest | Gets the length of contents | |
| getName.RspPage | Gets the (base)name of the current RSP file | |
| getContent.RspText | Gets the contents of the RSP text | |
| RspString | The RspString class | |
| asRspString.RspConstruct | Recreates an RSP string from an RspConstruct | |
| getNewline.RspLanguage | Gets the newline string specific for a given RSP response language | |
| getContentType.HttpRequest | Gets the MIME type of the body of the request | |
| getParameters.HttpRequest | Gets all parameters | |
| RRspPackage$capabilitiesOf | Checks which tools are supported | |
| findAsciiDoc | Locates the asciidoc executable | |
| compileRsp | Compiles an RSP file | |
| getFile.RspIncludeDirective | Gets the file attribute | |
| buildVignette | Builds a vignette | |
| RspEvalDirective | The RspEvalDirective class | |
| getType.RspPageDirective | Gets the content type | |
| evaluate.RspString | Parses, translates, and evaluates the RSP string | |
| escape.RspLanguage | Escapes a string specifically for a given RSP response language | |
| RspUnparsedExpression | The RspUnparsedExpression class | |
| parse.RspString | Parses the RSP string | |
| getComment.RspComment | Gets the comment | |
| rsptex | Compiles an RSP LaTeX file into a DVI file | |
| print.RspObject | Prints a summary of an RSP object | |
| evaluate.RspSourceCode | Evaluates the source code | |
| getInclude.RspConstruct | Checks whether an RSP construct will include text to the output or not | |
| HttpDaemon$getConfig | Retrieves the server's 'config' structure from Tcl | |
| compileKnitr | Compiles a Knitr file | |
| HttpDaemon$getPort | Gets the socket port of the HTTP daemon | |
| getRemoteAddress.HttpRequest | Gets the IP address of the client that sent the request | |
| getType.RspProduct | Gets the type of an RSP product | |
| getLanguage.RspSourceCodeFactory | Gets the language | |
| hasParameter.HttpRequest | Checks if a parameter exists | |
| getEcho.RspCode | Checks whether the source code should be echoed or not | |
| HttpDaemon$setRootPaths | Sets a new set of root directories for the HTTP daemon | |
| print.RspArguments | Prints RSP arguments | |
| getLanguage.RspLanguage | Gets the language string | |
| importRsp | Imports an RSP file | |
| requireAttributes.RspDirective | Asserts that certain attributes exist | |
| rcat | Evaluates an RSP string and outputs the generated string | |
| getType.RspString | Gets the type of an RSP string | |
| getSource.RspString | Gets the source reference of an RSP string | |
| view.RspProduct | Views the RSP product | |
| findPandoc | Locates the pandoc executable | |
| nbrOfLines.RspString | Gets the number of lines in an RSP string | |
| getFile.RspEvalDirective | Gets the file attribute | |
| getPath.RspPage | Gets the path of the directory of the current RSP file | |
| flatten.RspDocument | Flattens an RspDocument | |
| getMetadata.RspDocument | Gets the metadata of the RspDocument | |
| getSource.RspDocument | Gets the source reference of an RSP document | |
| compileSweave | Compiles a Sweave file | |
| sourceAllRsp | Processes one or several RSP files | |
| parse.RspRSourceCode | Parses the R code | |
| dropEmptyText.RspDocument | Drops all empty RSP text constructs | |
| getScheme.HttpRequest | Gets the scheme used to make this request | |
| openUrl.HttpDaemon | Starts the HTTP daemon and launches the specified URL | |
| trimNonText.RspDocument | Trims all non-text RSP constructs | |
| getWrap.RspIncludeDirective | Get the wrap length | |
| rfile | Evaluates and postprocesses an RSP document and outputs the final RSP document file | |
| RspSourceCodeFactory | The RspSourceCodeFactory class | |
| parseVignette | Parses an Rnw file | |
| RspResponse | The RspResponse class | |
| nbrOfParameters.HttpRequest | Gets the number of parameters | |
| getVerbatim.RspLanguage | Gets a verbatim string specific for a given RSP response language | |
| rscript | Compiles an RSP string and returns the generated source code script | |
| RspParser | The RspParser class | |
| import.RspResponse | Imports the output from another RSP file | |
| write.RspResponse | Writes an RSP response to the predefined output | |
| getComment.RspConstruct | Gets the comment of an RSP construct | |
| compileRnw | Compiles a Rnw file | |
| process.RspProduct | Processes an RSP file product | |
| rspWeave | A weave function for RSP documents | |
| getComment.RspLanguage | Gets a comment string specific for a given RSP response language | |
| toSourceCode.RspSourceCodeFactory | Translates an RSP document to source code | |
| HttpDaemon$processRsp | Processes an RSP page | |
| getAbsolutePath.RspPage | Gets the absolute pathname to the current RSP file | |
| rspTangle | A tangle function for RSP documents | |
| getType.RspDocument | Gets the type of the RspDocument | |
| parse.RspUnparsedExpression | Parses the unknown RSP expression for its class | |
| getParameter.HttpRequest | Gets a parameter | |
| RspPage | The RspPage class | |
| R.rsp-package | Package R.rsp | |
| getOutput.FileRspResponse | Gets the output for an RSP response | |
| toR.RspDocument | Translates the RSP document into R source code | |
| getCompleteCode.RspSourceCodeFactory | Gets the source code header, body, and footer | |
| getMetadata.RspString | Gets the metadata of the RspDocument | |
| rargs | Gets RSP arguments of an RSP document | |
| startHelp.HttpDaemon | Starts the HTTP daemon and launches the help page | |
| getRemoteHost.HttpRequest | Gets the fully qualified name of the client that sent the request | |
| getPath.FileRspResponse | Gets the path of the directory of the current RSP file | |
| parse.RspUnparsedDirective | Parses the unknown RSP directive for its class | |
| HttpDaemon$isStarted | Checks if the HTTP daemon is started | |
| sourceRsp | Processes an RSP file by translating it to an R servlet, which is then sourced | |
| rclean | Compiles an RSP document into a preprocessed and validated RSP document | |
| toR.RspString | Parses and translates the RSP string into R code | |
| HttpDaemon$getDefaultFilenamePattern | Gets the default filename pattern to be loaded by the HTTP daemon | |
| HttpDaemon$restart | Restarts the HTTP daemon | |
| parseVignettes | Locates and parses all vignettes | |
| writeResponse.HttpDaemon | Writes a string to the HTTP output connection | |
| tangle.RspSourceCode | Drops all text-outputting calls from the source code | |
| compileMarkdown | Compiles a Markdown file | |
| indexOfNonQuoted | Gets the first index of a string that is not inside a double qouted string | |
| evaluate.RspShSourceCode | Evaluates the shell (sh) code | |
| HttpDaemon$stop | Stops the HTTP daemon | |
| getMetadata.RspProduct | Gets the metadata an RSP product | |
| HttpDaemon$getHttpRequest | Gets the HTTP request | |
| parseRsp | Parse an RSP code string to an R RSP code string | |
| mergeTexts.RspDocument | Merge neighboring 'text' elements | |
| rstring | Evaluates an RSP string and returns the generated string | |
| preprocess.RspDocument | Processes all RSP preprocessing directives | |
| rspToHtml | Compiles an RSP file to an HTML file | |
| translateRsp | Translates an RSP file to an R RSP source file | |
| toLatex.character | Escapes character strings to become LaTeX compatible | |
| getServerPort.HttpRequest | Gets the port number on which this request was received | |
| getRealPath.HttpRequest | Gets the file system path for a given URI | |
| subset.RspDocument | Subsets an RspDocument | |
| getProtocol.HttpRequest | Gets the name and version of the protocol used to make this request | |
| No Results! | ||
Last month downloads
Details
| VignetteBuilder | R.rsp |
| Date | 2013-07-28 |
| License | LGPL (>= 2.1) |
| LazyLoad | TRUE |
| Packaged | 2013-07-29 13:06:57 UTC; hb |
| NeedsCompilation | no |
| Repository | CRAN |
| Date/Publication | 2013-07-29 23:39:01 |
| suggests | ascii , digest (>= 0.6.3) , knitr , markdown , R.devices (>= 2.2.2) , tcltk , tools |
| depends | base (>= 2.5.0) , R (>= 2.5.0) , R.utils (>= 1.26.0) |
| imports | R.methodsS3 (>= 1.4.4) , R.oo (>= 1.13.9) |
| Contributors | Henrik Bengtsson |
Include our badge in your README
[](http://www.rdocumentation.org/packages/R.rsp)