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