R.rsp v0.20.0

0

Monthly downloads

0th

Percentile

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

Last month downloads

Details

SuggestsNote Recommended: digest, R.devices, base64enc, markdown
VignetteBuilder R.rsp
Date 2015-02-18
License LGPL (>= 2.1)
URL https://github.com/HenrikBengtsson/R.rsp
BugReports https://github.com/HenrikBengtsson/R.rsp/issues
LazyLoad TRUE
NeedsCompilation no
Packaged 2015-02-18 20:20:28 UTC; hb
Repository CRAN
Date/Publication 2015-02-19 07:40:52

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/R.rsp)](http://www.rdocumentation.org/packages/R.rsp)